Skip to content
Authrim

Simulate admin policy decision

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

Evaluates matching policies against supplied admin user roles, attributes, and relationships and returns a final allow/deny/no_match 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
admin_user_context
required
object
roles
Array<string>
attributes
object
key
additional properties
relationships
Array<object>
object
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "resource": "/api/admin/users/user_123",
  "action": "read",
  "admin_user_context": {
    "roles": [
      "support"
    ],
    "attributes": {
      "department": "support"
    },
    "relationships": []
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
resource
required
string
action
required
string
decision
required
string
Allowed values: allow deny no_match
evaluations
required
Array<object>
object
key
additional properties
total_policies_evaluated
required
integer
key
additional properties
Example 
{
  "resource": "/admin/support/tickets",
  "action": "read",
  "decision": "allow",
  "evaluations": [
    {
      "policy_id": "policy_123",
      "policy_name": "allow_support_users",
      "matched": true,
      "effect": "allow",
      "priority": 100,
      "condition_results": {
        "roles": true
      }
    }
  ],
  "total_policies_evaluated": 1
}

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