Skip to content
Authrim

Evaluate token claim rules

POST
/api/admin/token-claim-rules/evaluate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/token-claim-rules/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "token_type": "access", "context": { "subject_id": "user_123", "client_id": "client_123", "scope": "openid profile", "roles": [ "employee" ], "permissions": [ "profile:read" ], "org_id": "org_123", "user_type": "member", "idp_claims": { "department": "Engineering" } } }'

Evaluates all matching token claim rules for a token type and returns claims to add or override.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

Token type and evaluation context for all claim rules.

Media type application/json
object
token_type
required
string
Allowed values: access id
context
required
object
subject_id
required
string
client_id
required
string
scope
string
roles
Array<string>
permissions
Array<string>
org_id
string
org_type
string
user_type
string
idp_claims
object
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "token_type": "access",
  "context": {
    "subject_id": "user_123",
    "client_id": "client_123",
    "scope": "openid profile",
    "roles": [
      "employee"
    ],
    "permissions": [
      "profile:read"
    ],
    "org_id": "org_123",
    "user_type": "member",
    "idp_claims": {
      "department": "Engineering"
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Evaluation result after applying all matching token claim rules.

Media type application/json
object
matched_rules
required
Array<string>
claims_to_add
required
object
key
additional properties
claim_overrides
required
object
key
additional properties
truncated
required
boolean
truncation_reason
string
key
additional properties
Example 
{
  "matched_rules": [
    "tcr_8f12"
  ],
  "claims_to_add": {
    "department": "Engineering"
  },
  "claim_overrides": {},
  "truncated": false,
  "truncation_reason": null
}

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