Skip to main content
POST
Create Role

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
name
string
required

Role name

description
string | null

Optional description of the role

userType
enum<string>
default:USER

Role type (ADMIN, PROVIDER, USER)

Available options:
ADMIN,
PROVIDER,
USER

Response

Successful Response

Extended role information including permissions

id
string
required

Unique identifier for the role

name
string
required

Role name (e.g., 'admin', 'user', 'billing_manager')

userType
enum<string>
required

Role type (ADMIN, PROVIDER, USER)

Available options:
ADMIN,
PROVIDER,
USER
createdDate
string<date-time> | null

When the role was created

updatedDate
string<date-time> | null

When the role was last updated

description
string | null

Description of what this role does

permissions
string[]

List of permission strings