コンテンツにスキップ
Authrim

Create a ReBAC relation definition.

POST
/api/admin/rebac/relation-definitions
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/rebac/relation-definitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "object_type": "document", "relation_name": "viewer", "definition": { "union": [ "owner", "editor" ] }, "description": "Users who can view documents.", "priority": 10, "is_active": true }'

Create a relation definition for an object type and relation name. Duplicate relation names within the same object type return conflict.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
object_type
required
string
relation_name
required
string
definition
required
object
key
additional properties
description
string
priority
integer
0
is_active
boolean
default: true
key
additional properties
Example 
{
  "object_type": "document",
  "relation_name": "viewer",
  "definition": {
    "union": [
      "owner",
      "editor"
    ]
  },
  "description": "Users who can view documents.",
  "priority": 10,
  "is_active": true
}

Responses

Section titled “ Responses ”

201

Section titled “201 ”

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
}

400

Section titled “400 ”

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

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

409

Section titled “409 ”

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