Skip to main content
POST
Suspend a tenant

Authorizations

Authorization
string
header
required

A machine-client token from POST /v1/auth/client-token. Provisioning and user management need the pulse.write scope; reads need pulse.read.

Path Parameters

tenantId
string<uuid>
required

Body

application/json
include_descendants
boolean
default:false

Response

OK

tenant_id
string<uuid>
required
status
string
required
changed_tenant_ids
string<uuid>[]
required