Skip to main content
POST
Error

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