Tenant Management API Overview
Overview
The Tenant Management APIs let you programmatically manage tenants 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
Examples
Example - create a tenant
- Call the Create Tenant API endpoint to create the tenant with the desired configuration.
- Add users to the tenant with Update User Add Tenant, Update User, or Create User.
- Optionally, configure SSO for the tenant via the SSO Management API.
Example - update a tenant's settings
Use the Update Tenant API endpoint to update the tenant's name or selfProvisioningDomains.
Update SSO WS-Fed IDP application POST
Update a SSO WS-Fed IDP application, using a valid management key.
Load All Tenants GET
### Load all tenants, using a valid management key. This API endpoint returns details of all configured tenants within the Descope instance. The response includes an array of the tenants and these details for each tenant: - id - name - selfProvisioningDomains ### Next Steps - Once you have this data, you can utilize the response to add users to the tenant via [Update User](/api/management/users/update-user) or [Create User](/api/management/users/create-user) - You can also apply sso configurations to the tenant via the [SSO Management API](/api/ssomanagement/) ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.