List Group Roles
- Print
- DarkLight
- PDF
List Group Roles
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/api/v1/groups.roles
List all the roles of users in the group.
Changelog
Version | Description |
---|---|
0.65.0 | Added |
Header parameters
X-Auth-Token
stringRequired
The authToken
of the authenticated user.
ExampleRScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f
X-User-Id
stringRequired
The userId
of the authenticated user.
ExamplerbAXPnMktTFbNpwtJ
Responses
200
OK
Example
{
"roles": [
{
"rid": "BaE62jfDLXK3Xo6BA",
"u": {
"_id": "BkNkw3iKgNyhMbPyW",
"username": "ronnie.dio",
"name": "Ronnie James Dio"
},
"roles": [
"moderator"
],
"_id": "ehPuGyZBedznJsQHp"
}
],
"success": true
}
object
roles
Array of object
object
rid
string
u
object
_id
string
username
string
name
string
roles
Array of string
string
_id
string
success
boolean
Was this article helpful?