Update tenant policy.

PUT

/api/admin/tenant-policy

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/tenant-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "ifMatch": "3", "policy": { "profile": "human", "metadata": { "status": "active" } } }'

Update the tenant policy contract with optimistic locking. The ifMatch value is required and must match the current policy version.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Request Body ^required

Media type application/json

object

ifMatch

required

string

policy

object

key

additional properties

key

additional properties

Example

{
  "ifMatch": "3",
  "policy": {
    "profile": "human",
    "metadata": {
      "status": "active"
    }
  }
}

Responses

200

Tenant policy update response.

Media type application/json

object

policy

required

object

tenantId

required

string

version

required

integer

preset

string

profile

string

Allowed values: human ai_ephemeral

metadata

object

key

additional properties

key

additional properties

previousVersion

required

integer

_links

required

object

key

additional properties

string

key

additional properties

Example

{
  "policy": {
    "profile": "human"
  }
}

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"
}

428

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"
}

503

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"
}