Get Roles
- Print
- DarkLight
- PDF
Get Roles
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/roles.list
Gets all the roles in the workspace.
Changelog
| Version | Description |
|---|---|
| 0.73.0 | Added mandatory2fa property |
| 0.70.0 | Added |
Header parameters
X-User-Id
stringRequired
The authenticated user ID.
ExamplerbAXPnMktTFbNpwtJ
X-Auth-Token
stringRequired
The authenticated user token.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
Responses
200
OK
Success Example
{
"roles": [
{
"_id": "admin",
"description": "Admin",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
},
{
"_id": "moderator",
"description": "Moderator",
"mandatory2fa": false,
"protected": true,
"scope": "Subscriptions"
},
{
"_id": "leader",
"description": "Leader",
"mandatory2fa": false,
"protected": true,
"scope": "Subscriptions"
},
{
"_id": "owner",
"description": "Owner",
"mandatory2fa": false,
"protected": true,
"scope": "Subscriptions"
},
{
"_id": "user",
"description": "",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
},
{
"_id": "bot",
"description": "",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
},
{
"_id": "guest",
"description": "",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
},
{
"_id": "anonymous",
"description": "",
"mandatory2fa": false,
"protected": true,
"scope": "Users"
},
{
"_id": "livechat-agent",
"name": "livechat-agent",
"scope": "Users"
},
{
"_id": "livechat-manager",
"name": "livechat-manager",
"scope": "Users"
},
{
"_id": "livechat-guest",
"name": "livechat-guest",
"scope": "Users"
}
],
"success": true
}object
roles
Array of object
object
_id
string
description
string
mandatory2fa
boolean
protected
boolean
scope
string
name
string
success
boolean
401
Unauthorized
Authorization Error
{
"status": "error",
"message": "You must be logged in to do this."
}object
status
string
message
string
Was this article helpful?