コンテンツにスキップ
Authrim

List policy rules.

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

List policy rules for the current tenant with optional enabled-state and text search filters.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
enabled
boolean

Filter policy rules by enabled state.

search
string

Search by policy name or description.

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 rule list response.

Media type application/json
object
rules
required
Array<object>
object
id
required
string
name
required
string
description
string
priority
required
integer
effect
required
string
Allowed values: allow deny
conditions
required
Array<object>
object
type
string
params
object
key
additional properties
key
additional properties
resource_types
required
Array<string>
actions
required
Array<string>
enabled
required
boolean
created_by
required
string | null
created_at
required
integer format: int64
updated_by
required
string | null
updated_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 
{
  "items": [
    {
      "id": "policy_123",
      "tenant_id": "tenant_123",
      "name": "allow_support_users",
      "display_name": "Allow support users",
      "effect": "allow",
      "priority": 100,
      "resource_pattern": "/admin/support/*",
      "actions": [
        "read"
      ],
      "conditions": {
        "condition_type": "all"
      },
      "is_active": {},
      "is_system": {
        "not": {}
      },
      "created_at": 1770000000000,
      "updated_at": 1770000000000
    }
  ],
  "total": 1,
  "limit": 50,
  "offset": 0
}

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