Skip to content
Authrim

List token claim rules

GET
/api/admin/token-claim-rules
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/token-claim-rules?limit=50&offset=0&token_type=access' \
  --header 'Authorization: Bearer <token>'

Lists tenant token claim rules with pagination and optional active/token-type filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 100

Maximum token claim rules to return.

offset
integer
0

Pagination offset.

is_active
boolean

Filter by active state.

token_type
string
Allowed values: access id

Return rules for this token type; rules with token_type both are included.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Token claim rules for the tenant.

Media type application/json
object
rules
required
Array<object>
object
id
required
string
tenant_id
required
string
name
required
string
description
string
token_type
required
string
Allowed values: access id both
condition
required
object
type
string
field
string
operator
string
value
key
additional properties
actions
required
Array<object>
object
claim_name
required
string
value
value_source
string
key
additional properties
priority
required
integer
is_active
required
boolean
stop_processing
required
boolean
valid_from
integer
valid_until
integer
created_by
string
created_at
required
integer
updated_at
required
integer
key
additional properties
total
required
integer
limit
required
integer
offset
required
integer
key
additional properties
Example 
{
  "rules": [
    {
      "id": "tcr_8f12",
      "tenant_id": "tenant_123",
      "name": "department-claim",
      "description": "Embed the user department claim when profile scope is requested.",
      "token_type": "access",
      "condition": {
        "type": "all",
        "conditions": [
          {
            "field": "scope",
            "operator": "contains",
            "value": "profile"
          }
        ]
      },
      "actions": [
        {
          "claim_name": "department",
          "source": "user_attribute",
          "source_key": "department",
          "include_if_empty": false
        }
      ],
      "priority": 10,
      "is_active": true,
      "stop_processing": false,
      "valid_from": 1770000000,
      "valid_until": 1770086400,
      "created_by": "admin_123",
      "created_at": 1770000000,
      "updated_at": 1770000000
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

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