Search Tenants | API Reference | Descope Documentation

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

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

Once you have this data, you can utilize the response to add users to the tenant via Update User or Create User
You can also apply sso configurations to the tenant via the SSO Management API

{
  "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"
    }
  ]
}

{  "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"    }  ]}

TypeScript

export interface Response {
tenants?: {
id?: string
name?: string
selfProvisioningDomains?: string[]
/**
 * Custom attributes as key-value pairs. Keys must be strings; values can be strings, numbers, booleans, or arrays.
 */
customAttributes?: {
[k: string]: string
}
authType?: string
domains?: string[]
createdTime?: number
disabled?: boolean
enforceSSO?: boolean
enforceSSOExclusions?: string[]
federatedAppIds?: string[]
parent?: string
successors?: string[]
defaultRoles?: string[]
roleInheritance?: 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?: string}[]}

Was this helpful?

Authorization

Request Body

Search all tenants, using a valid management key.

Next Steps

See also