{ "opencollection": "1.0.0", "info": { "name": "Stytch B2B Authentication Application SSO API", "version": "2.0.0" }, "items": [ { "info": { "name": "SSO", "type": "folder" }, "items": [ { "info": { "name": "Getconnections", "type": "http" }, "http": { "method": "GET", "url": "https://api.stytch.com/v1/b2b/sso/:organization_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." } ] }, "docs": "Get all SSO Connections owned by the organization." }, { "info": { "name": "Deleteconnection", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stytch.com/v1/b2b/sso/:organization_id/connections/:connection_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "The organization ID that the SSO connection belongs to. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the SSO connection. SAML, OIDC, and External connection IDs can be provided." } ] }, "docs": "Delete an existing SSO connection." }, { "info": { "name": "Authenticate", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/sso/authenticate", "body": { "type": "json", "data": "{}" } }, "docs": "Authenticate a user given a token. \nThis endpoint verifies that the user completed the SSO Authentication flow by verifying that the token is valid and hasn't expired.\nProvide the `session_duration_minutes` parameter to set the lifetime of the session. \nIf the `session_duration_minutes` parameter is not specified, a Stytch session will be created with a 60 minute duration.\nTo link this authentication event to an existing Stytch session, include either the `session_token` or `session_jwt` param.\n" }, { "info": { "name": "Createconnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/sso/oidc/:organization_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new OIDC Connection." }, { "info": { "name": "Updateconnection", "type": "http" }, "http": { "method": "PUT", "url": "https://api.stytch.com/v1/b2b/sso/oidc/:organization_id/connections/:connection_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific SSO `connection_id` for a Member." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing OIDC connection.\n\nWhen the value of `issuer` changes, Stytch will attempt to retrieve the [OpenID Provider Metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata) document found at `$/.well-known/openid-configuration`.\nIf the metadata document can be retrieved successfully, Stytch will use it to infer the values of `authorization_url`, `token_url`, `jwks_url`, and `userinfo_url`.\nThe `client_id` and `client_secret` values cannot be inferred from" }, { "info": { "name": "Createconnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/sso/saml/:organization_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new SAML Connection." }, { "info": { "name": "Updateconnection", "type": "http" }, "http": { "method": "PUT", "url": "https://api.stytch.com/v1/b2b/sso/saml/:organization_id/connections/:connection_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific SSO `connection_id` for a Member." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing SAML connection.\n\nNote that a newly created connection will not become active until all of the following are provided:\n* `idp_sso_url`\n* `attribute_mapping`\n* `idp_entity_id`\n* `x509_certificate`" }, { "info": { "name": "Updatebyurl", "type": "http" }, "http": { "method": "PUT", "url": "https://api.stytch.com/v1/b2b/sso/saml/:organization_id/connections/:connection_id/url", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific SSO `connection_id` for a Member." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Used to update an existing SAML connection using an IDP metadata URL.\n\nA newly created connection will not become active until all the following are provided:\n* `idp_sso_url`\n* `idp_entity_id`\n* `x509_certificate`\n* `attribute_mapping` (must be supplied using [Update SAML Connection](update-saml-connection))" }, { "info": { "name": "Deleteverificationcertificate", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stytch.com/v1/b2b/sso/saml/:organization_id/connections/:connection_id/verification_certificates/:certificate_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "The organization ID that the SAML connection belongs to. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "The ID of the SAML connection." }, { "name": "certificate_id", "value": "", "type": "path", "description": "The ID of the certificate to be deleted." } ] }, "docs": "Delete a SAML verification certificate.\n\nYou may need to do this when rotating certificates from your IdP, since Stytch allows a maximum of 5 certificates per connection. There must always be at least one certificate per active connection." }, { "info": { "name": "Deleteencryptionprivatekey", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.stytch.com/v1/b2b/sso/saml/:organization_id/connections/:connection_id/encryption_private_keys/:private_key_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific SSO `connection_id` for a Member." }, { "name": "private_key_id", "value": "", "type": "path", "description": "The ID of the encryption private key to be deleted." } ] }, "docs": "Delete a SAML encryption private key." }, { "info": { "name": "Createconnection", "type": "http" }, "http": { "method": "POST", "url": "https://api.stytch.com/v1/b2b/sso/external/:organization_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Create a new External SSO Connection." }, { "info": { "name": "Updateconnection", "type": "http" }, "http": { "method": "PUT", "url": "https://api.stytch.com/v1/b2b/sso/external/:organization_id/connections/:connection_id", "headers": [ { "name": "X-Stytch-Member-Session", "value": "" }, { "name": "X-Stytch-Member-SessionJWT", "value": "" } ], "params": [ { "name": "organization_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific Organization. The `organization_id` is critical to perform operations on an Organization, so be sure to preserve this value. You may also use the organization_slug or organization_external_id here as a convenience." }, { "name": "connection_id", "value": "", "type": "path", "description": "Globally unique UUID that identifies a specific External SSO Connection." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates an existing External SSO connection." } ] } ], "bundled": true }