Skip to content

Get tenant policy.

GET
/api/admin/tenant-policy
Code sample: Shell / cURL
curl --request GET \
--url https://auth.example.com/api/admin/tenant-policy \
--header 'Authorization: Bearer <token>'

Return the current tenant policy contract, creating and saving the default B2C standard contract when no tenant policy exists yet.

X-Tenant-Id
string

Tenant selector for multi-tenant admin requests.

Tenant policy 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
_links
required
object
key
additional properties
string
key
additional properties
Example
{
"policy": {
"tenantId": "default",
"version": 3,
"preset": "b2c-standard",
"profile": "human",
"metadata": {
"status": "active",
"updatedBy": "admin_123"
}
},
"_links": {
"self": "/api/admin/tenant-policy",
"presets": "/api/admin/tenant-policy/presets",
"validate": "/api/admin/tenant-policy/validate"
}
}

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