API Reference/Management/Tenants

SSO Management API Overview

Overview

Using the SSO management APIs enables administrators to manage their tenants' SSO configurations utilizing a management key.

Management keys are generated from Company > Management Keys. These keys will be used within the bearer token. The format is <Project ID>:<Management Key>.

Use Cases

SSO Management:

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

Examples

Example - Configure SSO on a tenant via manual configuration

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

Example - Configure SSO on a tenant via metadata URL

  1. Utilize 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. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

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. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

On this page