Skip to main content
POST
Suspend a tenant

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Reads need the pulse.read scope; provisioning and tenant updates need pulse.write, which the token only carries when requested_scopes asks for it. Creating, changing, disabling and resetting MFA for users, and the tenant sign-in policy, need a signed-in user's token instead: they reject API-key tokens.

Path Parameters

tenantId
string<uuid>
required

The tenant to suspend: a tenant_id from List tenants (GET /v1/msp/admin/tenants). It cannot be your own tenant.

Body

application/json

Optional: sending no body is the same as {"include_descendants": false}.

include_descendants
boolean
default:false

When true, the change also applies to every tenant beneath this one, at any depth. Defaults to false: only the tenant itself changes.

Response

OK

tenant_id
string<uuid>
required

The tenant named in the request.

status
string
required

The status the call moves tenants to: suspended for suspend, active for reactivate.

changed_tenant_ids
string<uuid>[]
required

The tenants this call actually changed. Tenants that were already in the target state are not listed, so the list is empty when nothing needed changing.