コンテンツにスキップ
Authrim

Check a ReBAC relationship.

POST
/api/admin/rebac/check
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/rebac/check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "user_id": "user_123", "relation": "viewer", "object": "doc_456", "object_type": "document" }'

Simulate a ReBAC permission check for a user, relation, and object, with optional contextual tuples for debugging and testing.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
user_id
required
string
relation
required
string
object
required
string
object_type
string
contextual_tuples
Array<object>
object
user_id
required
string
relation
required
string
object
required
string
object_type
string
key
additional properties
key
additional properties
Example 
{
  "user_id": "user_123",
  "relation": "viewer",
  "object": "doc_456",
  "object_type": "document"
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

ReBAC check response.

Media type application/json
object
allowed
required
boolean
resolved_via
string
path
Array<object>
object
key
additional properties
key
additional properties
Example generated
{
  "allowed": true,
  "resolved_via": "example",
  "path": [
    {
      "additionalProperty": "example"
    }
  ]
}

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

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