API ReferenceManagementTenants
POST
/v1/mgmt/tenant/update

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

id*string
Length1 <= length
name*string
Length1 <= length <= 254
selfProvisioningDomains?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

deprecated - authType should be set via ConfigureTenantSettings

disabled?boolean
enforceSSO?boolean
enforceSSOExclusions?array<string>
string
federatedAppIds?array<string>
string
roleInheritance?string
approvedDomains?object

Represents a dynamically typed value which can be either null, a number, a string, a boolean, a recursive struct value, or a list of values.

enforceSSOExclusionPermissions?array<string>
string

Permission names or IDs whose holders in the tenant may sign in without SSO while enforceSSO is on (break-glass accounts)

strict?boolean

When true, setting custom attributes the project does not declare for tenants returns error E111843 listing them: the request fails and nothing is saved. When false (default), those keys are ignored. An attribute declared in the last few seconds may still be ignored.

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

curl -X POST "https://api.descope.com/v1/mgmt/tenant/update" \  -H "Content-Type: application/json" \  -d '{    "id": "string",    "name": "string"  }'
Was this helpful?

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.

Delete Tenant POST

### Delete a tenant, using a valid management key. This API endpoint will delete a tenant utilizing a valid management key based on the provided user tenandId. ### See also - See [Tenant Management](/management/tenant-management) for further details on managing tenants.