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

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
idstring
namestring
selfProvisioningDomainsarray<string>
customAttributesobject
authTypestring

deprecated - authType should be set via ConfigureTenantSettings

disabledboolean
enforceSSOboolean
enforceSSOExclusionsarray<string>
federatedAppIdsarray<string>
curl -X POST "https://api.descope.com/v1/mgmt/tenant/update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "id": "string",
    "name": "string",
    "selfProvisioningDomains": [
      "string"
    ],
    "customAttributes": {},
    "authType": "string",
    "disabled": true,
    "enforceSSO": true,
    "enforceSSOExclusions": [
      "string"
    ],
    "federatedAppIds": [
      "string"
    ]
  }'

OK

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

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