コンテンツにスキップ
Authrim

Get a ReBAC relation definition.

GET
/api/admin/rebac/relation-definitions/{id}
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/rebac/relation-definitions/example \
  --header 'Authorization: Bearer <token>'

Return one relation definition for the current tenant by identifier.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Relation definition identifier.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Admin ReBAC definition response.

Media type application/json
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
Example 
{
  "id": "rebac_def_123",
  "tenant_id": "tenant_123",
  "relation_name": "manager_of",
  "display_name": "Manager of",
  "description": "Manager relationship.",
  "priority": 100,
  "is_system": false,
  "created_at": 1770000000000,
  "updated_at": 1770000000000
}

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

404

Section titled “404 ”

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