The password management endpoints provide functions that enable the following operations on a specified user:

Password state data model

Property Description
environment.id A string that specifies the ID of the environment resource referenced by this relationship.
lastChangedAt The time the password was last changed. This property is not returned if the user does not have a password.
passwordPolicy.id A string that specifies the ID of the password policy resource referenced by this relationship.
secondsUntilUnlock An integer that specifies the number of seconds before the password may be used again after a lock out. If absent, the password must be reset by an administrator before it may be used again after a lockout.
status A string that specifies the current status of the password. Options are OK, NO_PASSWORD, PASSWORD_EXPIRED, PASSWORD_LOCKED_OUT, and MUST_CHANGE_PASSWORD.
user.id A string that specifies the ID of the user resource referenced by this relationship.
warnings.expires The password will expire on the specified date and time.
warnings.failuresRemaining There has been recent attempts to check the password unsuccessfully and will be locked out after the indicated number of further unsuccessful attempts.
warnings.noChangeUntil The password was recently self-changed and cannot be self-changed again until the specified date and time.