GET /config/access/user_roles/{id}

Edit online

Get a deployed user role by ID.

Get a deployed user role by ID. The ADMIN or SAASADMIN capabilities are required to call this endpoint. If called by a user or authorized service with the ADMIN capability, any deployed user role will be returned. If called by a user or authorized service with the SAASADMIN capability, any deployed user role without the ADMIN capability will be returned.

Table 1. GET /config/access/user_roles/{id} resource details
MIME Type

application/json

Table 2. GET /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 /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 deployed User Role.
  • id - Long - The ID of the user role.
  • name - String - The name of the user role.

Response Sample


{
    "id": 42,
    "name": "String"
}