API ReferenceManagementTenants

SSO Management API Overview

Overview

The SSO Management APIs let you programmatically manage tenant SSO configurations using a management key.

Management keys are generated from Company > Management Keys. Include the key in the Authorization header as a bearer token in the format <Project ID>:<Management Key>.

Use Cases

  1. Get Tenant SAML/OIDC Settings
  2. Configure SAML Settings
  3. Configure SAML Metadata URL
  4. Configure OIDC Settings
  5. Delete SSO Settings

Examples

Example - configure SSO via manual configuration

  1. Call the Configure SSO Settings API endpoint to apply idpURL, entityId, idpCert, and redirectURL to a tenant.

Example - configure SSO via metadata URL

  1. Call the Configure SSO Metadata URL API endpoint to apply the idpMetadataURL to a tenant.
Was this helpful?

Update Tenant Session Settings POST

### Update session settings for a tenant This endpoint allows you to update the session settings of a given tenant. ### See Also - See [tenant session settings](/customize/tenant#session-management) for details about tenant session settings.

Get Tenant's SAML/OIDC Settings GET

### Get the current SAML/OIDC configuration settings of a tenant, using a valid management key. This API endpoint allows you to get the current SAML/OIDC configuration settings of a tenant. ### See also - See [SSO Configuration](/sso) for further details on managing SSO Configurations on a tenant.

On this page

SSO Management API OverviewOverviewUse CasesExamplesExample - configure SSO via manual configurationExample - configure SSO via metadata URL