GET /config/access/user_roles

Get the list of deployed user roles available in the system.

If called by a user or authorized service with the ADMIN capability, all deployed user roles will be returned. If called by a user or authorized service with the SAASADMIN capability, all deployed user roles without the ADMIN capability will be returned. If called by a user or authorized service without either the ADMIN or SAASADMIN only the user role of the caller will be returned. If called by any user or authorized service with the current_user_role parameter with 'true' only the user role of the caller will be returned.

Table 1. GET /config/access/user_roles resource details
MIME Type
application/json

Table 2. GET /config/access/user_roles request parameter details
Parameter	Type	Optionality	Data Type	MIME Type	Description
current_user_role	query	Optional	Boolean	text/plain	If provided will only return the caller's user role.
contains	query	Optional	String	text/plain	If this parameter is provided, the endpoint will return all user roles that contain the provided capability.
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.
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.
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.

Table 3. GET /config/access/user_roles response codes
HTTP Response Code	Unique Code	Description
200		A list of the deployed user roles.
500	1020	null

Response Description

Returns an array of user roles.

id - Long - The ID of the User Role. The ID of the staged and the ID of the same deployed user are the same.
name - String - The name of the User Role.
capabilities - Array of Capabilities - The user role's capabilities
application_id - Integer - The application ID of the capability, for example 25 is the Event Viewer.
name - String - The name of the capability.
description - String - A description of the capability.

Response Sample


[
    {
        "capabilities": [
            {
                "application_id": 42,
                "description": "String",
                "name": "String"
            }
        ],
        "id": 42,
        "name": "String"
    }
]