Logo
Akamai APIs API Documentation

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.

 

Body PARAM

Key Datatype Required Description 
groupId
string (Optional) Filters roles for a specific group. To get this value, run the [List groups](https://techdocs.akamai.com/iam-api/reference/get-groups) operation.
authGrants
string (Optional) Includes the list of your group and role assignments, `false` by default.
actions
string (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](https://techdocs.akamai.com/iam-api/reference/put-user-profile-tfa) operation.
accountSwitchKey
string (Optional) For customers who manage more than one account, this [runs the operation from another account](https://techdocs.akamai.com/developer/docs/manage-many-accounts-with-one-api-client). The Identity and Access Management API provides a [list of available account switch keys](https://techdocs.akamai.com/iam-api/reference/get-client-account-switch-keys).



HEADERS

Key Datatype Required Description 
Accept
string




RESPONSES

Curl
curl -X GET 'https://host/identity-management/v3/user-admin/ui-identities?groupId=&authGrants=&actions=&accountSwitchKey=' -H 'Accept: application/json'

ENDPOINTS