Skip to content

List roles

GET
/api/v1/roles

Returns all roles including built-in and custom roles.

page
integer format: int32

Page number (1-based).

pageSize
integer format: int32

Items per page.

Role list

object
data
Array<object>
object
name
string
permissions
Array<string>
builtIn
required
boolean
userCount
required
integer format: int64
page
required
integer format: int32
pageSize
required
integer format: int32
total
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