Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
 

GET /config/access/user_roles

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

Get the list of deployed user roles available in the system. The ADMIN or SAASADMIN capabilities are required to call this endpoint.

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

contains

query

Optional

String

text/plain

null

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.

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.

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

An unexpected error has occurred.

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.

Response Sample