Skip to content
Authrim

List admin relationships

GET
/api/admin/admin-relationships
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/admin-relationships \
  --header 'Authorization: Bearer <token>'

Lists admin ReBAC relationships for the tenant with optional relationship type filter and limit/offset metadata.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Query Parameters

Section titled “Query Parameters ”
type
string

Relationship type filter.

limit
integer
>= 1

Maximum number of records to return.

offset
integer

Zero-based offset.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin relationship list response.

Media type application/json
object
items
required
Array<object>
object
id
required
string
tenant_id
required
string
relationship_type
required
string
from_type
required
string
from_id
required
string
to_type
required
string
to_id
required
string
permission_level
required
string
expires_at
required
integer | null format: int64
is_bidirectional
required
boolean
metadata
required
object | null
created_at
required
integer format: int64
updated_at
required
integer format: int64
key
additional properties
total
required
integer
limit
integer
offset
integer
key
additional properties
Example 
{
  "items": [
    {
      "id": "rel_123",
      "tenant_id": "tenant_123",
      "relationship_type": "manager_of",
      "from_type": "admin_user",
      "from_id": "admin_manager",
      "to_type": "admin_user",
      "to_id": "admin_member",
      "permission_level": "limited",
      "is_transitive": {
        "not": {}
      },
      "is_bidirectional": {
        "not": {}
      },
      "metadata": {},
      "created_by": "admin_123",
      "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"
}