Skip to content

Create role

POST
/api/v1/roles

Create a custom role. Name must match [A-Z][A-Z0-9_]* and be at most 32 characters.

object
name
string
permissions
Array<string>

Role created

object
name
string
permissions
Array<string>
builtIn
required
boolean
userCount
required
integer format: int64

Invalid role name or permissions

object
error
object
code
string
message
string
status
required
integer format: int32

Unauthorized

object
error
object
code
string
message
string
status
required
integer format: int32

Forbidden

object
error
object
code
string
message
string
status
required
integer format: int32

Role name already exists

object
error
object
code
string
message
string
status
required
integer format: int32