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