API Reference/Management/Tenants
POST
/v1/mgmt/tenant/search

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
tenantIdsarray<string>
tenantNamesarray<string>
tenantSelfProvisioningDomainsarray<string>
customAttributesobject
authTypestring
curl -X POST "https://api.descope.com/v1/mgmt/tenant/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "tenantIds": [
      "string"
    ],
    "tenantNames": [
      "string"
    ],
    "tenantSelfProvisioningDomains": [
      "string"
    ],
    "customAttributes": {},
    "authType": "string"
  }'

OK

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

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

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