Create role (deprecated path)

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,
    "dac": "own-data",
    "created_by_user_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

This path is deprecated and will be removed in the following major release. Use /api/governance/rbac/roles instead.

This endpoint is available in Bifrost Enterprise only.

Authorizations

ManagementBearerAuthBasicAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

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