Skip to main content
POST
/
api
/
v1
/
roles
Create Role
curl --request POST \
  --url https://api.example.com/api/v1/roles \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>"
}
'
{
  "id": 123,
  "name": "<string>",
  "description": "<string>"
}

Body

application/json

Request schema for creating a role.

Attributes: name: Role name (e.g., 'editor', 'viewer'). description: Optional description of the role's purpose.

​
name
string
required
​
description
string | null

Response

Successful Response

Response schema for a role.

Attributes: id: Role ID. name: Role name. description: Role description.

​
id
integer
required
​
name
string
required
​
description
string | null