コンテンツにスキップ
Authrim

List role assignment rules.

GET
/api/admin/role-assignment-rules
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/role-assignment-rules?limit=50&offset=0' \
  --header 'Authorization: Bearer <token>'

List automatic role assignment rules for the current tenant with optional active-state filtering.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
limit
integer
default: 50 >= 1 <= 100

Items per page, default 50 and maximum 100.

offset
integer
0

Zero-based result offset, default 0.

is_active
boolean

Filter by active state.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Role assignment rule list response.

Media type application/json
object
rules
required
Array<object>
object
id
required
string
tenant_id
required
string
name
required
string
description
string | null
role_id
required
string
scope_type
required
string
scope_target
required
string | null
condition
required
object
key
additional properties
actions
required
Array<object>
object
key
additional properties
priority
required
integer
is_active
required
boolean
stop_processing
required
boolean
valid_from
integer | null format: int64
valid_until
integer | null format: int64
created_by
string | null
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
total
required
integer
limit
required
integer
offset
required
integer
key
additional properties
Example generated
{
  "rules": [
    {
      "id": "example",
      "tenant_id": "example",
      "name": "example",
      "description": "example",
      "role_id": "example",
      "scope_type": "example",
      "scope_target": "example",
      "condition": {
        "additionalProperty": "example"
      },
      "actions": [
        {
          "additionalProperty": "example"
        }
      ],
      "priority": 1,
      "is_active": true,
      "stop_processing": true,
      "valid_from": 1,
      "valid_until": 1,
      "created_by": "example",
      "created_at": 1,
      "updated_at": 1
    }
  ],
  "total": 1,
  "limit": 1,
  "offset": 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"
}