Skip to main content

Role

This is an object representing a role in the system.

idstringrequired

Unique identifier for the role.

Possible values: Value must match regular expression ^role_\w{12}$

namestringrequired

The name of the role.

objectstringrequired

String representing the object's type.

Possible values: [role]

typestringrequired

The type of the role.

Possible values: [admin, staff, developer, superuser, custom]

Role
{
"id": "role_123456789012",
"name": "Admin",
"object": "role",
"type": "admin"
}