POST
/
roles
Create role
curl --request POST \
  --url https://api.identety.dev/roles \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "Content Editor",
  "description": "Can manage and publish content",
  "is_system": false
}'
{
  "id": "uuid-123",
  "name": "admin_role",
  "description": "Administrator role with full access",
  "is_system": false,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required

Role name will be converted to snake_case automatically

Example:

"Content Editor"

​
description
string
Example:

"Can manage and publish content"

​
is_system
boolean

Whether this is a system role. Cannot be set to true manually.

Example:

false

Response

Role created successfully.

​
id
string
required
Example:

"uuid-123"

​
name
string
required
Example:

"admin_role"

​
description
string
required
Example:

"Administrator role with full access"

​
is_system
boolean
required
Example:

false

​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required