Create role

Creates a custom role with the specified data access control scope. If dac is omitted, defaults to all-data.

POST /api/roles

Error

A valid request URL is required to generate request examples

200

{
  "role": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "is_system_role": true,
    "created_by_user_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <API key>. Virtual keys, dashboard/user/session tokens, and x-api-key headers are not supported on management APIs.

Body

application/json

name · string · required

Must match ^[a-z][a-z0-9_.]*$. Max 255 characters. Unique.

Maximum string length: 255

description · string

dac · enum<string>

Defaults to all-data when omitted.

Available options: own-data, team-data, all-data

Response

200

application/json

Role created

role · object

Show child attributes