Skip to main content
GET
Gets the configuration of the existing SSO integration

Authorizations

X-API-KEY
string
header
required

Response

Configuration of current SSO integration

type
enum<string>
required

The type of SSO integration, currently only SAML is supported.

Available options:
SAML
identityProvider
string
required

The name of your identity provider. This value will be displayed to users when they log in.

Note: This value cannot be the strings "Google" or "SAML" as they're reserved words in our identity management platform.

Pattern: ^(?=[a-zA-Z0-9\(\)\.\-!@]+$)(?!Google|SAML$).*$
Examples:

"Okta"

"GoogleWorkspace"

"OneLogin"

"JumpCloud"

metadataDocumentEndpointUrl
string
required

The URL of the SAML metadata document. Either this or metadataFileContents must be provided.

Example:

"https://company.okta.com/app/123456789/sso/saml/metadata"