Skip to content
Authrim

List admin ReBAC definitions

GET
/api/admin/admin-rebac-definitions
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/admin-rebac-definitions?include_system=true' \
  --header 'Authorization: Bearer <token>'

Lists admin ReBAC relationship type definitions, including system definitions unless include_system=false.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
include_system
boolean
default: true

Include system relationship definitions.

limit
integer
>= 1

Maximum number of records to return.

offset
integer

Zero-based offset.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
definitions
required
Array<object>
object
id
required
string
tenant_id
required
string
object_type
required
string
relation_name
required
string
definition
required
object
key
additional properties
description
required
string | null
priority
required
integer
is_active
required
boolean
created_at
required
integer format: int64
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": "rebac_def_123",
      "tenant_id": "tenant_123",
      "relation_name": "manager_of",
      "display_name": "Manager of",
      "description": "Manager relationship.",
      "priority": 100,
      "is_system": {
        "not": {}
      },
      "created_at": 1770000000000,
      "updated_at": 1770000000000
    }
  ],
  "total": 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"
}