Package com.pingidentity.sdk.password

Interface RecoverableUsername

public interface RecoverableUsername
Implemented by a PasswordCredentialValidator to support recovering a user's login ID through a 'Forgot username' link and sending the username to the specified email address.
Since:
9.1
See Also:

  • Method Details

    • findUsersByMail

      List<AttributeMap> findUsersByMail(String mail) throws UsernameRecoveryException
      Retrieves a List of AttributeMaps from the user(s) in the data store by the provided email search filter.

      If the user is found, an List<AttributeMap>> is returned with the following attributes: 

        Key                                     Value
  ===================================     ===================================
  Value of getUsernameAttribute()         The username to send in the recovered username email.
  Value of getNameAttribute()             The name of the user
  Value of getMailVerifiedAttribute()     The email verification status

      If the user is not found a UsernameRecoveryException is thrown.

      Parameters:
      mail - the email address of the user to find.
      Returns:
      a List of AttributeMaps. Each map corresponds to a found user account. Multiple accounts are possible as email addresses may not be unique.
      Throws:
      UsernameRecoveryException

    • getMailVerifiedAttribute

      String getMailVerifiedAttribute()
      The boolean attribute/field that contains the status of email verification for the user.

    • getUsernameAttribute

      String getUsernameAttribute()
      The attribute/field that contains the registered email for the user.

    • getNameAttribute

      String getNameAttribute()
      The attribute/field that contains the name of the user.