public interface ResettablePasswordCredential
PasswordCredentialValidator
to support resetting user passwords through the 'Forgot Password' link in the backing data store.PasswordCredentialValidator
Modifier and Type | Method and Description |
---|---|
AttributeMap |
findUser(String username)
Retrieves a map of attributes from the user in the data store.
|
String |
getMailAttribute()
The attribute/field that contains the registered email for the user.
|
String |
getMailVerifiedAttribute()
The boolean attribute/field that contains the status of email verification for the user.
|
String |
getNameAttribute()
The attribute/field that contains for the common name for the user.
|
String |
getPingIdUsernameAttribute()
The attribute/field containing the username to use for PingID based password reset.
|
String |
getSmsAttribute()
The attribute/field that contains the phone number to send the password reset SMS text to.
|
boolean |
isPasswordResettable()
Indicate whether passwords can be changed in the current state.
|
void |
resetPassword(String username,
String password)
Resets the password for the given user.
|
AttributeMap findUser(String username) throws PasswordResetException
AttributeMap
is returned with the following attributes:
Key Value =========================== =========================== Value ofIf the user is not found agetMailAttribute()
The email address of the user to send the password reset email to. Value ofgetNameAttribute()
The name of the user. Value ofgetSmsAttribute()
The phone number of the user to send the password reset SMS text to. Value ofgetPingIdUsernameAttribute()
The username to use for PingID based password reset.
PasswordResetException
is thrown.username
- the name of the user to find.PasswordResetException
void resetPassword(String username, String password) throws PasswordResetException
username
- The user account to resetpassword
- The new password to setPasswordResetException
- if password reset failsboolean isPasswordResettable()
PasswordCredentialValidator
, it could also depend on some system configuration
or current condition. For example, passwords can only be changed in Active Directory if SSL is
enabled on the LDAP data store.
String getNameAttribute()
String getMailAttribute()
String getSmsAttribute()
String getPingIdUsernameAttribute()
String getMailVerifiedAttribute()
Copyright 2019 Ping Identity Corp. All rights reserved.