ON THIS PAGE
GET /staged_config/access/user_roles
SUMMARY Get the list of staged user roles available in the system.
Get the list of staged user roles available in the system. The ADMIN or SAASADMIN capabilities are required to call this endpoint.
MIME Type |
---|
application/json |
Parameter | Type | Optionality | Data Type | MIME Type | Description |
---|---|---|---|---|---|
contains |
query |
Optional |
String |
text/plain |
null |
Range |
header |
Optional |
String |
text/plain |
Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero. |
fields |
query |
Optional |
String |
text/plain |
Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas. |
filter |
query |
Optional |
String |
text/plain |
Optional - This parameter is used to restrict the elements in a list base on the contents of various fields. |
HTTP Response Code | Unique Code | Description |
---|---|---|
200 |
A list of the deployed user roles. |
|
500 |
1020 |
An unexpected error has occurred. |
Response Description
- id - Long - The ID of the user role. The ID of the staged and the ID of the same staged user are the same.
- name - String - The name of the user role.
Response Sample
[ { "id": 42, "name": "String" } ]