List roles
GET https://{{host}}/identity-management/v3/user-admin/roles
This operation lists roles for the current account and contract type or other accounts using the accountSwitchKey parameter. The account and contract type are determined by the access tokens in your API client.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
actions | string | (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. | |
groupId | string | (Optional) Filters roles for a specific group. To get this value, run the List groups operation. | |
users | string | (Optional) Returns users assigned to the roles, false by default. | |
ignoreContext | string | (Optional) Returns all the roles for the current account, ignoring the contract type of your API client, false by default. | |
accountSwitchKey | string | (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
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
[{"actions":{"delete":true,"edit":true},"createdBy":"jkowalski@example.com","createdDate":"2023-07-27T18:11:25.000Z","modifiedBy":"szhang@example.com","modifiedDate":"2023-07-27T18:11:25.000Z","roleDescription":"This role will allow you to view","roleId":123456,"roleName":"View Only","type":"custom"},{"actions":{"delete":false,"edit":false},"createdBy":"hgildong","createdDate":"2023-07-27T18:11:25.000Z","modifiedBy":"szhang","modifiedDate":"2023-07-27T18:11:25.000Z","numUsers":2,"roleDescription":"This role allows for 'read only'","roleId":13,"roleName":"Accounting","type":"standard","users":[{"accountId":"A-CCT3456","email":"jsmith@example.com","firstName":"John","lastLoginDate":"2017-08-03T21:15:27.000Z","lastName":"Smith","uiIdentityId":"A-B-1BCDEF"},{"accountId":"A-CCT1234","email":"jkowalski@example.com","firstName":"Jan","lastLoginDate":"2016-09-07T00:00:00.000Z","lastName":"Kowalski","uiIdentityId":"1-ABCDE"}]}]