v1

latestOpenAPI 3.1.02026-07-242735131.1 MB
SSO Configuration

Create the SSO Configuration

Creates the SSO Configuration for the company.

Scopes

CategoryRead only ScopeWrite only Scope (read access implicit)
Manage company resources (company_admin)-Manage SSO (sso_configuration:write)
post/v1/sso-configuration

Request body

certificatestring binary required

The SAML signing certificate from your identity provider, base64-encoded.

domainstring required

The email domain(s) to route through SSO (e.g., "example.com").

identity_provider_urlstring required

The URL of the SAML identity provider login endpoint.

Example request

{
  "certificate": "c29tZSBjZXJ0aWZpY2F0ZSBleGFtcGxl...",
  "domain": "example.com",
  "identity_provider_url": "example.provider.com"
}

Response

Created

Example response

{
  "data": {
    "audience_uri": "urn:auth:remote-sso:89c4fbb2-some-id-8e4b-280f8795bbd8",
    "certificate": "c29tZSBjZXJ0aWZpY2F0ZSBleGFtcGxl...",
    "domain": "example.com",
    "identity_provider_url": "example.provider.com",
    "sso_url": "https://remote-sso.com/login/callback?connection=89c4fbb2-some-id-8e4b-280f8795bbd8"
  }
}