Skip to content
Authrim

Evaluate admin policies

POST
/api/admin/admin-policies/evaluate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/admin-policies/evaluate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "resource": "/api/admin/users/user_123", "action": "read" }'

Returns active policies matching a resource and action. This endpoint reports matching policies rather than making a final authorization decision.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
resource
required
string
action
required
string
key
additional properties
Example 
{
  "resource": "/api/admin/users/user_123",
  "action": "read"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
resource
required
string
action
required
string
matching_policies
required
Array<object>
object
key
additional properties
key
additional properties
Example 
{
  "resource": "/admin/support/tickets",
  "action": "read",
  "matching_policies": [
    {
      "id": "policy_123",
      "name": "allow_support_users",
      "effect": "allow",
      "priority": 100,
      "conditions": {
        "condition_type": "all"
      }
    }
  ]
}

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