API ReferenceManagementTenants
POST
/v1/mgmt/tenant/search

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

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/tenant/search

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

tenantIdsarray<string>

tenantNamesarray<string>

tenantSelfProvisioningDomainsarray<string>

customAttributesobject

authTypestring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/tenant/search" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "tenantIds": [
    "string"
  ],
  "tenantNames": [
    "string"
  ],
  "tenantSelfProvisioningDomains": [
    "string"
  ],
  "customAttributes": {},
  "authType": "string"
}'

{
  "tenants": [
    {
      "id": "string",
      "name": "string",
      "selfProvisioningDomains": [
        "string"
      ],
      "customAttributes": {},
      "authType": "string",
      "domains": [
        "string"
      ],
      "createdTime": 0
    }
  ]
}

Was this helpful?

Previous

Load Tenant By ID

Next

Create Tenant