User Role

Retrieve UserRoles

GET

Retrieves the list of UserRoles defined within this Workspace.

A UserRole is a name for a privilege level granted to a specific User. The ‘Global Admin’ UserRole is granted to the owner of the Workspace, and this UserRole cannot be changed. You can choose which UserRole applies to a User within your Workspace.

Response

This endpoint returns an object
error
objectOptional
If the API call failed, this will contain information about the error that occurred.
success
booleanOptional
True if the API call succeeded; false otherwise.
hasError
booleanOptional
True if the API call failed.
statusCode
enumOptional
The HTTP code of the response.
data
list of objectsOptional
If the API call succeeded, this will contain the results.
GET
1curl /api/data/users/roles \
2 -H "Authorization: Bearer <token>"
200
Retrieved
1{
2 "error": {
3 "technicalError": "technicalError",
4 "additionalErrors": [
5 "additionalErrors"
6 ],
7 "message": "message"
8 },
9 "success": true,
10 "hasError": true,
11 "statusCode": "Continue",
12 "data": [
13 {
14 "id": "id",
15 "name": "name"
16 }
17 ]
18}