Skip to content
Authrim

Update token embedding settings

PUT
/api/admin/settings/token-embedding
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/token-embedding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "policy_embedding_enabled": true, "custom_claims_enabled": true, "id_level_permissions_enabled": false, "max_embedded_permissions": 100, "max_resource_permissions": 250, "max_custom_claims": 20 }'

Updates token embedding feature flags and limits in SETTINGS KV. At least one valid setting is required.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
policy_embedding_enabled
boolean
custom_claims_enabled
boolean
id_level_permissions_enabled
boolean
max_embedded_permissions
integer
>= 1 <= 500
max_resource_permissions
integer
>= 1 <= 1000
max_custom_claims
integer
>= 1 <= 100
key
additional properties
Example 
{
  "policy_embedding_enabled": true,
  "custom_claims_enabled": true,
  "id_level_permissions_enabled": false,
  "max_embedded_permissions": 100,
  "max_resource_permissions": 250,
  "max_custom_claims": 20
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Token embedding settings.

Media type application/json
object
policy_embedding_enabled
boolean
custom_claims_enabled
boolean
id_level_permissions_enabled
boolean
limits
object
maxEmbeddedPermissions
integer
maxResourcePermissions
integer
maxCustomClaims
integer
key
additional properties
last_updated
string format: date-time
key
additional properties
Example 
{
  "policy_embedding_enabled": true,
  "custom_claims_enabled": true,
  "id_level_permissions_enabled": false,
  "limits": {
    "max_embedded_permissions": 100,
    "max_resource_permissions": 250,
    "max_custom_claims": 20
  },
  "last_updated": "2026-06-20T00:00:00.000Z"
}

400

Section titled “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"
}

401

Section titled “401 ”

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

403

Section titled “403 ”

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

404

Section titled “404 ”

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

500

Section titled “500 ”

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