Skip to content
Authrim

List policy simulation history.

GET
/api/admin/policies/simulations
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/policies/simulations?page=1&limit=20' \
  --header 'Authorization: Bearer <token>'

List saved policy simulation results for the current tenant in reverse chronological order.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
page
integer
default: 1 >= 1

Page number, default 1.

limit
integer
default: 20 >= 1 <= 100

Items per page, default 20 and maximum 100.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Policy simulation history response.

Media type application/json
object
simulations
required
Array<object>
object
id
required
string
context
required
object
subject
required

The subject: id, roles ({ name, scope: global | org | resource, scopeTarget such as org: or resource:: }) and verifiedAttributes ({ name, value }).

object
key
additional properties
resource
required
object
type
required
string
id
string
ownerId
string
orgId
string
key
additional properties
action
required
object
name
required
string
key
additional properties
timestamp

When the request is evaluated, in UNIX milliseconds (default now).

integer
environment
object
key
additional properties
key
additional properties
allowed
required
boolean
reason
required
string
decided_by
required
string | null
details
required
object | null
simulated_by
required
string | null
simulated_at
required
integer format: int64
key
additional properties
pagination
required
object
page
required
integer
limit
required
integer
total
required
integer
total_pages
required
integer
key
additional properties
key
additional properties
Example generated
{
  "simulations": [
    {
      "id": "example",
      "context": {
        "subject": {
          "additionalProperty": "example"
        },
        "resource": {
          "type": "example",
          "id": "example",
          "ownerId": "example",
          "orgId": "example"
        },
        "action": {
          "name": "example"
        },
        "timestamp": 1,
        "environment": {
          "additionalProperty": "example"
        }
      },
      "allowed": true,
      "reason": "example",
      "decided_by": "example",
      "details": "example",
      "simulated_by": "example",
      "simulated_at": 1
    }
  ],
  "pagination": {
    "page": 1,
    "limit": 1,
    "total": 1,
    "total_pages": 1
  }
}

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