API ReferenceManagementTenants
POST
/v1/mgmt/tenant/update

Update a tenant, using a valid management key.

This API endpoint will update a tenant utilizing a valid management key. Utilizing this API endpoint will allow you to update the name or selfProvisioningDomains settings of the tenant.

Next Steps

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/tenant/update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

idstring

namestring

selfProvisioningDomainsarray<string>

customAttributesobject

authTypestring

deprecated - authType should be set via ConfigureTenantSettings

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/tenant/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "id": "string",
  "name": "string",
  "selfProvisioningDomains": [
    "string"
  ],
  "customAttributes": {},
  "authType": "string"
}'
Was this helpful?

Previous

Create Tenant

Next

Delete Tenant