API ReferenceManagementTenants
POST
/v1/mgmt/tenant/search

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

tenantIds?array<string>
string
tenantNames?array<string>
string
tenantSelfProvisioningDomains?array<string>
string
customAttributes?object

Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.

Example{ "attribute-key": "attribute-value" }
authType?string
tenantSSODomains?array<string>
string
parentTenantId?string
Lengthlength <= 254
topLevelOnly?boolean

Search all tenants, using a valid management key.

This API endpoint returns details of configured tenants within the Descope instance that match the search parameters. The response includes an array of the tenants and these details for each tenant:

  • id
  • name
  • selfProvisioningDomains

Next Steps

See also

curl -X POST "https://api.descope.com/v1/mgmt/tenant/search" \  -H "Content-Type: application/json" \  -d '{}'
{  "tenants": [    {      "id": "string",      "name": "string",      "selfProvisioningDomains": [        "string"      ],      "customAttributes": {        "attribute-key": "attribute-value"      },      "authType": "string",      "domains": [        "string"      ],      "createdTime": 0,      "disabled": true,      "enforceSSO": true,      "enforceSSOExclusions": [        "string"      ],      "federatedAppIds": [        "string"      ],      "parent": "string",      "successors": [        "string"      ],      "defaultRoles": [        "string"      ],      "roleInheritance": "string",      "additionalSSOConfigs": [        {          "ssoId": "string",          "name": "string",          "authType": "string"        }      ],      "approvedDomains": [        "string"      ],      "enforceSSOExclusionPermissions": [        "string"      ]    }  ]}
export interface Response {tenants?: {id?: stringname?: stringselfProvisioningDomains?: string[]/** * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays. */customAttributes?: {[k: string]: string}authType?: stringdomains?: string[]createdTime?: numberdisabled?: booleanenforceSSO?: booleanenforceSSOExclusions?: string[]federatedAppIds?: string[]parent?: stringsuccessors?: string[]defaultRoles?: string[]roleInheritance?: stringadditionalSSOConfigs?: AdditionalSSOConfiguration[]/** * The tenant's vanity hostname (e.g. surveys.example.com), unique across the project's tenants. Requests that reach the project through its trusted proxy on this hostname are bound to this tenant. One item for now */approvedDomains?: string[]/** * Permission names or IDs whose holders in the tenant may sign in without SSO while enforceSSO is on (break-glass accounts) */enforceSSOExclusionPermissions?: string[]}[]}export interface AdditionalSSOConfiguration {ssoId?: stringname?: stringauthType?: string}
Was this helpful?

Load Tenant By ID GET

### Load tenant by ID, using a valid management key. This API endpoint returns details of the tenant within the Descope instance that matches the ID provided. 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.

Create Tenant POST

### Create a new tenant, using a valid management key. This API endpoint will create a new tenant utilizing a valid management key. Creation of a new tenant can set the name, id, and selfProvisioningDomains. The id and selfProvisioningDomains are not mandatory. The id will be autogenerated if not provided. The response will always include the tenantId. ### Next Steps - You can then 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.