Skip to main content
POST
/
rbac
/
scopes
Error
A valid request URL is required to generate request examples
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "resource": "<string>",
  "action": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "source_ref": "<string>",
  "organization_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

​
fastapiusersauth
string
cookie
required

Body

application/json

Create schema for a custom scope.

​
name
string
required

Scope name in format resource:action (e.g., 'custom:read')

Required string length: 1 - 255
Pattern: ^[a-z0-9:_.*-]+$
​
description
string | null

Optional description of the scope

Maximum string length: 512

Response

Successful Response

Read schema for a scope.

​
id
string<uuid>
required
​
name
string
required
​
resource
string
required
​
action
string
required
​
source
enum<string>
required

Source/ownership of a scope definition.

Available options:
platform,
custom
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
source_ref
string | null
​
organization_id
string<uuid> | null