Skip to main content
PUT
/
v0
/
settings
/
sso
Configure (create or update) an SSO integration in Gable
curl --request PUT \
  --url https://{hostname}.gable.ai/v0/settings/sso \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "type": "SAML",
  "identityProvider": "<string>",
  "metadataDocumentEndpointUrl": "https://company.okta.com/app/123456789/sso/saml/metadata"
}
'
{
  "type": "SAML",
  "identityProvider": "<string>",
  "metadataDocumentEndpointUrl": "https://company.okta.com/app/123456789/sso/saml/metadata"
}

Authorizations

X-API-KEY
string
header
required

Body

application/json

Configuration for setting up SSO

  • Option 1
  • Option 2
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.

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"

Response

SSO was successfully configured

  • Option 1
  • Option 2
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.

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"