Qodex.ai

Get a role

GET https://{{host}}/identity-management/v3/user-admin/roles/:roleId

This operation retrieves a role's details.

Request Params

KeyDatatypeRequiredDescription
actionsstring(Optional) Includes information about actions such as edit or delete that you can take for the object, false by default. Don't confuse this with the action parameter, which applies to the Set two-factor authentication operation.
grantedRolesstring(Optional) Lists granted roles assigned for a role, false by default.
usersstring(Optional) Returns users assigned to the roles, false by default.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"actions":{"delete":false,"edit":false},"createdBy":"afero@example.com","createdDate":"2017-07-27T18:11:25.000Z","grantedRoles":[{"grantedRoleDescription":"Security View Only","grantedRoleId":12345,"grantedRoleName":"SecurityViewOnly"}],"modifiedBy":"asingh@example.com","modifiedDate":"2017-07-27T18:11:25.000Z","roleDescription":"This role will allow you to look at the security reports","roleId":123456,"roleName":"Security View Only","type":"custom","users":[{"accountId":"A-CCT9012","email":"jsmith@example.com","firstName":"John","lastLoginDate":"2017-08-03T21:15:27.000Z","lastName":"Smith","uiIdentityId":"A-B-12345"},{"accountId":"A-CCT1234","email":"jkowalski@example.com","firstName":"Jan","lastLoginDate":"2016-09-07T00:00:00.000Z","lastName":"Kowalski","uiIdentityId":"1-2ABCD"}]}