API Reference/Management

Tenant Management API Overview

Overview

Using the tenant management APIs enables administrators to manage their tenants 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

Tenant Management:

  1. Load All Tenants
  2. Load Tenant By ID
  3. Search Tenants
  4. Create Tenant
  5. Update Tenant
  6. Delete Tenant

Examples

Example - create tenant

  1. Utilize the Create Tenant api endpoint to create the tenant and apply the correct configuration to the tenant.
  2. You can then add users to the tenant via Update User Add Tenant, Update User, or Create User
  3. You can apply also sso configurations to the tenant via the SSO Management API

Example - update a tenants's settings

Utilize the Update Tenant api endpoint to update the name or selfProvisioningDomains settings of the tenant.

Was this helpful?

Delete Application POST

### Delete an Application within a project This endpoint deletes an Application within your Descope project. ### See Also - Review our [documentation](/manage/idpapplications/) around Applications within Descope. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

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

On this page