Patch Tenant

Patches the specified tenant.

Required Permissions

Below is the list of required permissions needed to interact with this API. For each permission the allowed permission boundaries are also specified.

PermissionBoundaryDescription
tenant:updateApplicationThe subject can update any tenant belonging to the application that the subject belongs to.
TenantThe subject can update the tenant that it is associated to.
Tenant Inclusion ListThe subject can update the tenants specified in the inclusion list.
Tenant Exclusion ListThe subject can update the tenant only if it belongs to the subject's application and it is not included in the exclusion list.
SelfThe subject can update the tenant that it is associated to.

Field Level Permissions

In addition to the aforementioned permissions, the following permissions are conditionally required depending on the fields being updated. The permission boundaries that apply to the tenant:update permission also apply to the fied level permissions.

PermissionCondition
tenant:manage-signup-enablementRequired if the signupEnabled field is modified
tenant:manage-restricted-metadataRequired if the restrictedMetadata field is modified
tenant:manage-statusRequired if the state field is modified
Language
Authorization
Bearer
JWT
URL
Click Try It! to start a request and see the response here!