Users

Number of APIs: 5

1. Create a user

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

This operation creates a user, or clones an existing user's role assignments, in the account specified in your API client credentials. Optionally, sends a randomly generated one-time use password to the new user. If you send the email with the password directly to the user, the response for this operation doesn't include that password. If you don't send the password to the user through email, the password is included in the response.

---

2. 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.

---

3. Get a user

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

This operation retrieves a user's profile.

---

4. Remove a user

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

This operation deletes any user who doesn't own an API client. Before you delete a user with a client, transfer API client ownership to another user.

---

5. Update a user

PUT https://{{host}}/identity-management/v3/user-admin/ui-identities/:uiIdentityId/basic-info

This operation modifies a user's basic information. Pass the entire body of data in the request, including members you're not changing, or the unspecified data are removed. To edit detailed settings, run the Modify a user's group and role assignments or Update a user's notifications operations.

---