Skip to content
Authrim

Update a ReBAC relation definition.

PUT
/api/admin/rebac/relation-definitions/{id}
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/rebac/relation-definitions/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "definition": { "union": [ "owner", "editor", "auditor" ] }, "priority": 20, "is_active": true }'

Update the definition JSON, description, priority, or active state for one relation definition and return a success object.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
id
required
string

Relation definition identifier.

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
>= 1 properties
definition
object
key
additional properties
description
string
priority
integer
is_active
boolean
key
additional properties
Example 
{
  "definition": {
    "union": [
      "owner",
      "editor",
      "auditor"
    ]
  },
  "priority": 20,
  "is_active": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
key
additional properties
Example 
{
  "success": true
}

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