Roles
The roles
namespace provides API methods to retrieve all or specific user roles. This page covers the following API methods:
GET /roles
/roles
Returns all roles. Requires site admin access.
This method uses pagination so you might need to request additional pages to retrieve all roles.
Request
|
|
|
This method supports the following expands so you can automatically include additional information for referenced objects:
users
Response
Examples
Status codes
200
400
401
403
422
(details)
GET /roles/{role_id}
/roles/{role_id}
Returns a single role. Requires site admin access.
|
Request
|
This method supports the following expands so you can automatically include additional information for referenced objects:
users
Response
Examples
Status codes
200
400
401
403
404
422
(details)
Last updated