Skip to content
Authrim

Simulate policy evaluation.

POST
/api/admin/policies/simulate
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/policies/simulate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "context": { "subject": { "id": "user_123", "roles": [ "viewer" ] }, "resource": { "type": "user", "id": "user_456" }, "action": "read" }, "save_history": true }'

Evaluate enabled policy rules against a supplied context and optionally persist the simulation history for later review.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
context
required
object
subject
object
key
additional properties
resource
object
key
additional properties
action
string
environment
object
key
additional properties
key
additional properties
save_history
boolean
key
additional properties
Example 
{
  "context": {
    "subject": {
      "id": "user_123",
      "roles": [
        "viewer"
      ]
    },
    "resource": {
      "type": "user",
      "id": "user_456"
    },
    "action": "read"
  },
  "save_history": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Policy simulation response.

Media type application/json
object
allowed
required
boolean
reason
required
string
decided_by
string | null
details
object | null
evaluated_rules
required
integer
key
additional properties
Example 
{
  "allowed": true,
  "reason": "Matched allow rule",
  "decided_by": "policy_123",
  "details": {
    "matched_rule": "policy_123"
  },
  "evaluated_rules": 3
}

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