Skip to content
Authrim

Evaluate role assignment rules

POST
/api/admin/role-assignment-rules/evaluate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/role-assignment-rules/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "context": { "email": "[email protected]", "email_verified": true, "provider_id": "google", "idp_claims": { "hd": "example.com" }, "user_type": "employee" } }'

Evaluates all active tenant role assignment rules against a supplied context and returns the final role, organization, attribute, and deny outcome.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
context
required
object
email
string
email_verified
boolean
provider_id
string
idp_claims
object
key
additional properties
user_type
string
key
additional properties
key
additional properties
Example 
{
  "context": {
    "email": "[email protected]",
    "email_verified": true,
    "provider_id": "google",
    "idp_claims": {
      "hd": "example.com"
    },
    "user_type": "employee"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Role assignment rule evaluation response.

Media type application/json
object
matched_rules
required
Array<object>
object
key
additional properties
final_roles
required
Array<string>
final_orgs
required
Array<string>
attributes_to_set
required
object
key
additional properties
denied
required
boolean
deny_code
string | null
deny_description
string | null
key
additional properties
Example generated
{
  "matched_rules": [
    {
      "additionalProperty": "example"
    }
  ],
  "final_roles": [
    "example"
  ],
  "final_orgs": [
    "example"
  ],
  "attributes_to_set": {
    "additionalProperty": "example"
  },
  "denied": true,
  "deny_code": "example",
  "deny_description": "example"
}

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

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