Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 

GET /staged_config/access/user_roles/{id}

 

Get a staged user role by ID.

Get a staged user role by ID. The staged configuration is not active until a deploy is performed. The ADMIN or SAASADMIN capabilities are required to call this endpoint.

Table 1: GET /staged_config/access/user_roles/{id} Resource Details

MIME Type

application/json

Table 2: GET /staged_config/access/user_roles/{id} Request Parameter Details

Parameter

Type

Optionality

Data Type

MIME Type

Description

id

path

Required

Number (Integer)

text/plain

The ID of the staged user role to get.

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 /staged_config/access/user_roles/{id} Response Codes

HTTP Response Code

Unique Code

Description

200

 

The staged user role was retrieved.

404

38341001

The user role id does not exist.

Response Description

A single staged User Role.

  • id - Long - The ID of the user role.

  • name - String - The name of the user role.

Response Sample