The user account management endpoint provides functionality to unlock a user account. For information about how to configure account lockout for MFA actions, see MFA Settings.
| Property | Type | Required? | Mutable? | Description |
|---|---|---|---|---|
account.canAuthenticate |
Boolean | Required | Mutable | Indicates whether the user can authenticate. If the value is set to false, the account is locked or the user is disabled, and unless specified otherwise by the administrative configuration, the user will be unable to authenticate. |
account.lockedAt |
Date | N/A | Read-only | The date-time the specified user account was locked. This property might be absent if the account is unlocked or if the account was locked out automatically by failed password attempts. |
account.secondsUntilUnlock |
Integer | Optional | Read-only | The number of seconds until the user’s account is unlocked. This property is absent if the account is unlocked, or if it will not automatically unlock (and must be unlocked by an administrator). |
account.status |
String | Required | Mutable | The account locked state. Options are LOCKED and OK. |
account.unlockAt |
Date | Optional | Mutable | The time the specified user account will be unlocked. This property is absent if the account is unlocked, or if it will not automatically unlock (and must be unlocked by an administrator). |