IAdmSelfPasswordResetManager

The IAdmSelfPasswordResetManager interface is used to manage a password self-service session for a user.

Inheritance: IUnknown

Methods

  • Method

  • Description

  • GetQuestion()

  • Returns a security question for the user for whom the password self-service session was created.

  • AnswerQuestion()

  • Sets the given answer for the question at the given index.

  • SendVerificationCode()

  • Sends an SMS verification code to the user for whom the password self-service session was created.

  • CheckVerificationCode()

  • Sets an SMS verification code to validate during this password self-service session.

  • GeneratePassword()

  • Generates a random password.

  • GetPasswordPolicy()

  • Gets information about the password policy of the user for whom the password self-service session was created.

  • ResetPassword()

  • Resets the password of the user for whom the password self-service session was created.

Properties

  • Property

  • Description

  • QuestionsAndAnswersEnabled

  • Gets a value that indicates whether the Security Questions and Answers feature is enabled in the password self-service policy applied to the user.

  • NumberQuestionsToAnswer

  • Gets the number of security questions the user needs to answer.

  • AnswersAreCaseSensitive

  • Gets a value that indicates whether user answers are case sensitive.

  • SmsVerificationEnabled

  • Gets a value that indicates whether the SMS Verification feature is enabled in the password self-service policy applied to the user.

  • SmsVerificationMobileNumber

  • Gets the user's mobile number to send SMS verification codes to.

  • CaptchaEnabled

  • Gets a value that indicates whether a captcha (word verification image) is displayed before resetting a password.

Details

GetQuestion()

Returns a security question for the user for whom the password self-service session was created. The question is retrieved by its index. The highest index depends on the number of questions the user has to answer which is specified by the NumberQuestionsToAnswer property.

string GetQuestion(int questionIndex)

AnswerQuestion()

Sets the given answer for the question at the given index.

void AnswerQuestion(int questionIndex, string answer)

Parameters

  • questionIndex - Specifies the index of the question.
  • answer - Specifies the answer.

Remarks

For user password to be reset, you need to set correct answers for all questions that a user is required to answer. To get the questions, use the GetQuestion method.

Exceptions

  • Softerra.Adaxes.Adsi.PasswordSelfService.SelfPasswordResetException
  • The specified answer is incorrect.

SendVerificationCode()

Sends an SMS verification code to the user for whom the password self-service session was created.

void SendVerificationCode()

CheckVerificationCode()

Sets an SMS verification code to validate during this password self-service session. For the user password to be reset, the code needs to match the one sent by the SendVerificationCode method.

void CheckVerificationCode(string verificationCode)

Exceptions

  • Softerra.Adaxes.Adsi.PasswordSelfService.SelfPasswordResetException
  • The provided verification code does not match the one sent by the SendVerificationCode method.

GeneratePassword()

Generates a random password.

string GeneratePassword()

Remarks

If the Force random passwords option is enabled in the password self-service policy applied to the user, you need to provide a password generated by this method when calling the ResetPassword method.

GetPasswordPolicy()

Gets information about the password policy of the user for whom the password self-service session was created.

IAdmPasswordPolicyInfo GetPasswordPolicy()

ResetPassword()

Resets the password of the user for whom the password self-service session was created.

void ResetPassword(string newPassword)

Exceptions

  • Softerra.Adaxes.Adsi.PasswordSelfService.SelfPasswordResetException

  • The user has not completed all the steps required to reset the password.

    The provided password does not meet the complexity requirements imposed by the password policy applied to them.

    The Force random passwords option is enabled in the password self-service Policy applied to the user, but the provided password was not generated using the GeneratePassword method.

QuestionsAndAnswersEnabled

Gets a value that indicates whether the Security Questions and Answers feature is enabled in the password self-service Policy applied to the user.

  • Type:
  • bool
  • Access:
  • Read-only

NumberQuestionsToAnswer

Gets the number of security questions the user needs to answer.

  • Type:
  • int
  • Access:
  • Read-only

AnswersAreCaseSensitive

Gets a value that indicates whether user answers are case sensitive.

  • Type:
  • bool
  • Access:
  • Read-only

SmsVerificationEnabled

Gets a value that indicates whether the SMS Verification feature is enabled in the password self-service policy applied to the user.

  • Type:
  • bool
  • Access:
  • Read-only

SmsVerificationMobileNumber

Gets the user's mobile number to send SMS verification codes to.

  • Type:
  • string
  • Access:
  • Read-only

CaptchaEnabled

Gets a value that indicates whether a captcha (word verification image) is displayed before resetting a password.

  • Type:
  • bool
  • Access:
  • Read-only

Requirements

Minimum required version: 2011.3

See also

© Softerra 2022. All rights reserved.
Send feedback