Skip to main content
POST
Create Role

Authorizations

Authorization
string
header
required

API key or JWT token

Body

application/json
name
string
required

Role name, unique within the organization.

Example:

"analyst"

description
string
color
string

Role color in hex format (#RRGGBB). Omit or use an empty string for no color.

Example:

"#7c3aed"

icon
string

Supported role icon name from the role appearance picker. Omit or use an empty string for no icon.

Example:

"database"

Response

The created role

id
string
Example:

"80de0196-496f-44fe-9d4c-8013b3b44082"

name
string
Example:

"analyst"

description
string
color
string

Role color in hex format (#RRGGBB), or an empty string when unset.

Example:

"#7c3aed"

icon
string

Lucide icon name, or an empty string when unset.

Example:

"database"

is_system
boolean

True for the built-in roles (for example admin and member).

is_scim_managed
boolean
created_at
string

RFC 3339 timestamp

Example:

"2026-07-06T19:30:00Z"

updated_at
string

RFC 3339 timestamp

Example:

"2026-07-06T19:30:00Z"