Patch Tenant
Use Patch Tenant to update specific fields on a tenant without resending the entire tenant object.
Why use Patch Tenant instead of Update Tenant
Update Tenant expects the full tenant object on every call. Any field you leave out gets reset to its zero value. For example, if you call Update Tenant and leave out disabled, it gets set back to false. If you leave out customAttributes, it gets cleared to {}.
Patch Tenant only changes the fields you include in the request. Everything else on the tenant stays exactly as it was.
This matters most when you only want to change one thing. For example, if you want to add a new federated app ID to a tenant, Update Tenant requires you to also resend the tenant's disabled state, its self-provisioning domains, its custom attributes, and every other field, or those get wiped. Patch Tenant lets you send just the federatedAppIds field and nothing else changes.
Endpoint
PATCH /v1/mgmt/tenant/patchRequires the same permission as Update Tenant. No new auth setup is needed if you already call Update Tenant today.
Fields
| Field | Behavior |
|---|---|
name | Set if provided, otherwise unchanged |
disabled | Set if provided, otherwise unchanged |
enforceSSO | Set if provided, otherwise unchanged |
authType | Set if provided and non-empty. An empty string is ignored, not applied. Deprecated in favor of Configure Tenant Settings. See note below |
selfProvisioningDomains | See note on list fields below |
enforceSSOExclusions | See note on list fields below |
federatedAppIds | See note on list fields below |
customAttributes | See note on custom attributes below |
roleInheritance | Only takes effect on sub-tenants. See note below |
List fields: selfProvisioningDomains, enforceSSOExclusions, federatedAppIds
For these three fields, leaving the field out of the request and explicitly sending null do the same thing: the existing list is left unchanged.
To clear one of these lists, send an explicit empty array []. Sending null will not clear it.
This behavior has been confirmed against a live tenant.
Custom attributes
customAttributes is merged key by key, not replaced as a whole:
- A key that maps to a real value is added or updated.
- A key that maps to JSON
nullis deleted. - Any key you don't mention is left untouched.
There is currently no way to clear the entire custom attributes map in a single call. Sending null at the top level, or omitting the field entirely, does nothing. To fully clear it, you would need to explicitly null out every existing key, and you would need to already know their names.
This behavior is based on the source code and its unit tests. It has not been independently confirmed against a live tenant.
Auth type
authType on Patch Tenant is functional, but deprecated in favor of Configure Tenant Settings. Configure Tenant Settings sets the auth type alongside the other settings that govern SSO behavior, such as domains and enablement, in one atomic call. Patch Tenant's authType only flips the tenant's auth type selector. It does not configure the underlying SAML or OIDC provider settings, which are managed separately.
Sending authType: "" is silently ignored. It does not change the tenant's auth type and does not return an error. Only a non-empty valid value (none, saml, or oidc) is applied. An invalid non-empty value is rejected.
Prefer Configure Tenant Settings for auth type changes. Use Patch Tenant for it only when you need a bare selector flip alongside other unrelated fields in the same call.
Role inheritance and sub-tenants
roleInheritance only applies to sub-tenants (tenants that have a parent tenant set). If you call Patch Tenant with roleInheritance set on a tenant that has no parent, the request succeeds with no error, but the field is not applied and the tenant's role inheritance setting does not change.
Patch Tenant returns a success response even when a field you sent was silently ignored, such as an empty authType or roleInheritance on a non-sub-tenant. The response alone cannot tell you whether a field was applied. To confirm a change took effect, load the tenant again after patching it.
SDK support
Patch Tenant is not currently available in the Go, Node, or Python management SDKs. It can be called directly through the REST API or gRPC. If your workflow depends on SDK support for this endpoint, you'll need to call the REST API directly in the meantime.
Example
Update only the disabled state of a tenant, leaving everything else untouched:
PATCH /v1/mgmt/tenant/patch
{
"id": "T2abc123",
"disabled": true
}Every other field on the tenant, including its name, custom attributes, and domains, is left exactly as it was.