Qodex.ai

List users

GET https://{{host}}/identity-management/v3/user-admin/ui-identities

This operation lists the users who have access to your current account or other managed accounts using the accountSwitchKey parameter. The account is determined by the tokens in your API client. You can pass a groupId to filter users based on group. You can also return user information such as what product notifications they subscribe to, or what group and role assignments they have. Set the actions parameter to true to return the actions you can take on each user.

Request Params

KeyDatatypeRequiredDescription
groupIdstring(Optional) Filters roles for a specific group. To get this value, run the List groups operation.
authGrantsstring(Optional) Includes the list of your group and role assignments, false by default.
actionsstring(Optional) Includes actions such as edit or delete that a user can perform on an object, false by default. Don't confuse this with the action parameter, which applies to the Set two-factor authentication operation.
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

[{"accountId":"A-CCT3456","actions":{"delete":true,"apiClient":true,"canEditMFA":false,"canEditNone":false,"canEditTFA":false,"edit":true,"editProfile":true,"isCloneable":true,"resetPassword":true,"thirdPartyAccess":true},"additionalAuthentication":"TFA","additionalAuthenticationConfigured":false,"authGrants":[{"groupId":12345,"groupName":"Internet Company","isBlocked":false,"roleDescription":"Role giving admin access.","roleId":12,"roleName":"admin"}],"email":"jsmith@example.com","firstName":"John","isLocked":false,"lastLoginDate":"2016-01-13T17:53:57Z","lastName":"Smith","tfaConfigured":false,"tfaEnabled":false,"uiIdentityId":"A-B-123456","uiUserName":"jsmith"}]