Freeze a tenant.

POST

/api/admin/tenants/{id}/lifecycle/freeze

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/tenants/example/lifecycle/freeze \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "expected_state": "provisioning", "expected_updated_at": 1, "reason": "example", "break_glass": false }'

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

Header Parameters

Idempotency-Key

string

Idempotency key for state-changing operations that support replay protection.

Request Body ^required

Media type application/json

object

expected_state

required

string

Allowed values: provisioning active suspended frozen migration_read_only deleting deleted restore_pending restore_validating

expected_updated_at

required

integer format: int64

reason

required

string

>= 3 characters <= 1000 characters

break_glass

boolean

key

additional properties

Responses

200

Tenant lifecycle command or validation job response.

Media type application/json

object

job_id

required

string

status

required

string

tenant_id

required

string

lifecycle_state

required

string

Allowed values: provisioning active suspended frozen migration_read_only deleting deleted restore_pending restore_validating

validation_required

required

boolean

idempotent_replay

boolean

key

additional properties

Example

{
  "lifecycle_state": "provisioning"
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

409

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}