User authentication settings

Number of APIs: 7

1. Unlock a user's account

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

This operation releases the lock on a user's account, allowing access to Control Center. The result shows in the user data as a read-only isLocked:false indicator. To prevent a user access to Control Center, run the Lock a user's account operation. This sets the isLocked indicator to true.

---

2. Lock a user's account

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

This operation locks a user's account, preventing access to Control Center. The result shows in the user data as a read-only isLocked: true indicator. To allow a user access to Control Center, run the Unlock a user's account operation. This sets the isLocked indicator to false.

---

3. Reset a user's password

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

This operation sends a one-time use password to the 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.

---

4. Set a user's password

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

This operation sets a password for a user. This differs from Reset a user's password because this password may be used more than once, and isn't randomly generated.

---

5. Set multi-factor authentication for your user profile

PUT https://{{host}}/identity-management/v3/user-profile/additionalAuthentication

This operation sets multi-factor authentication to TFA, MFA, or NONE. You have five login attempts with MFA or 2FA before your account is locked. If your account is locked, use the Reset multi-factor authentication for your user profile operation to unlock it.

---

6. Reset multi-factor authentication for your user profile

PUT https://{{host}}/identity-management/v3/user-profile/additionalAuthentication/reset

This operation resets your multi-factor authentication.

---

7. Rotate your password

POST https://{{host}}/identity-management/v3/user-profile/change-password

This operation changes your password. Include your old password and your new password in the request body. Before you create your new password, run the View password policy operation to ensure it adheres to your policy. If you include your existing password incorrectly and make too many login attempts, your account locks.

---