Load Tenant By ID | API Reference | Descope Documentation

GET

/v1/mgmt/tenant

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 or Create User
You can also apply sso configurations to the tenant via the SSO Management API

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Authorization

`Authorization`
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Query Parameters

`id`string

Status code	Description
`200`	OK

curl -X GET "https://api.descope.com/v1/mgmt/tenant?id=string"

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

Was this helpful?

Load tenant by ID, using a valid management key.

Next Steps

See also

Endpoint Authentication

Try it

Authorization

`Authorization`
Required
Bearer <token>

Query Parameters

`id`string

Load tenant by ID, using a valid management key.

Next Steps

See also

Endpoint Authentication

Try it

Query

Authorization

AuthorizationRequiredBearer <token>

Query Parameters

idstring

Response

Typescript

`Authorization`
Required
Bearer <token>

`id`string