IAdmPasswordSelfServicePolicy

The IAdmPasswordSelfServicePolicy interface represents a Password Self-Service Policy.

Inheritance: IAdmTop

Methods

Properties

  • Property

  • Description

  • QuestionsAndAnswersEnabled

  • Gets or sets a value that indicates whether the Security Questions and Answers feature is enabled for the Self-Password Reset process.

  • NumberQuestionsToAnswer

  • Gets or sets the number of security questions necessary to enroll for Password Self-Service.

  • Questions

  • Gets or sets a collection of questions available for a user to answer in order to reset their password.

  • NumberUserQuestions

  • Gets or sets the number of user-defined questions that are allowed by the policy.

  • UserQuestionMinLength

  • Gets or sets the minimum length of a user-defined question.

  • AnswerMinLengthEnabled

  • Gets or sets a value that indicates whether user's answers are limited by minimum length.

  • AnswerMinLength

  • Gets or sets the minimum length of a user's answer.

  • IdenticalAnswersAllowed

  • Gets or sets a value that indicates whether a user is allowed to provide identical answers to two or more questions.

  • AnswersAreCaseSensitive

  • Gets or sets a value that indicates whether user's answers are case sensitive.

  • AnswerCannotBePartOfQuestion

  • Gets or sets a value that indicates whether an answer can be a part of the question.

  • SmsVerificationEnabled

  • Gets or sets a value that indicates whether the SMS Verification feature is enabled for the Self-Password Reset process.

  • SmsVerificationMessage

  • Gets or sets a template for the SMS verification message.

  • SmsVerificationNoMobileNumberBypassed

  • Gets or sets a value that indicates whether SMS verification is bypassed when a user does not have a mobile number assigned.

  • BlockAccountInvalidAttemptsEnabled

  • Gets or sets a value that indicates whether a user account is blocked from using the Self-Password Reset feature.

  • BlockAccountInvalidAttemptsNumber

  • Gets or sets the number of invalid attempts a user must make before their account is blocked from using the Self-Password Reset feature.

  • ResetFailedAttemptsEnabled

  • Gets or sets a value that indicates whether the invalid attempts counter is reset automatically after a period of time specified by the ResetFailedAttemptsTimespan property.

  • ResetFailedAttemptsTimespan

  • Gets or sets the number of seconds after which the invalid attempts counter will be reset for the user automatically.

  • AutoUnblockAccountEnabled

  • Gets or sets a value that indicates whether a blocked account will be automatically unblocked after a period of time specified by the AutoUnblockAccountTimespan property.

  • AutoUnblockAccountTimespan

  • Gets or sets the number of seconds after which a blocked account will be unblocked automatically.

  • UnlockAccountEnabled

  • Gets or sets a value that indicates whether a user can unlock their account during Self-Password Reset.

  • EnrollmentInvitationEnabled

  • Gets or sets a value that indicates whether enrollment invitations will be sent to users affected by this policy.

  • EnrollmentInvitationSubject

  • Gets or sets the subject of the enrollment invitation email.

  • EnrollmentInvitationText

  • Gets or sets the text of the enrollment invitation email.

  • EnrollmentInvitationFrequency

  • Gets or sets a value indicating how often enrollment invitations will be sent.

  • PasswordResetNotificationEnabled

  • Gets or sets a value that indicates whether a notification must be sent to a user when the Self-Password Reset process is completed.

  • PasswordResetNotificationSubject

  • Gets or sets the subject of the password reset notification.

  • PasswordResetNotificationText

  • Gets or sets the text of the password reset notification.

  • CaptchaEnabled

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

  • AutoReenrollmentEnabled

  • Gets or sets a value that indicates whether an enrolled account that doesn't meet the current policy will be forced to re-enroll.

  • ActivityScopeItems

  • Gets a collection of scope items that represents the activity scope of the Password Self-Service Policy.

  • Priority

  • Gets or sets a value that specifies the priority of the policy.

  • Enabled

  • Gets or sets a value that indicates whether the Password Self-Service Policy is enabled.

Details

FindAffectedUsers()

Returns an object that can be casted to the IAdmDirectorySearcher interface. The interfaces can be used to find all users affected by the Password Self-Service Policy.

object FindAffectedUsers()

SendEnrollmentNotification()

Initiates sending Password Self-Service enrollment notifications to all unenrolled users that are affected by the policy.

void SendEnrollmentNotification()

QuestionsAndAnswersEnabled

Gets or sets a value that indicates whether the Security Questions and Answers feature is enabled for the Self-Password Reset process.

  • Type:
  • bool
  • Access:
  • Read/Write

NumberQuestionsToAnswer

Gets or sets the number of security questions necessary to enroll for Password Self-Service.

  • Type:
  • int
  • Access:
  • Read/Write

Remarks

If the IAdmPasswordSelfServicePolicy4::NumberQuestionsToVerify property is set to 0, this property also sets the number of questions a user needs to answer in order to reset a password or unlock their account.

Questions

Gets or sets a collection of questions available for a user to answer in order to reset their password. Each question in the collection is represented by the IAdmPasswordSelfServiceQuestion interface.

NumberUserQuestions

Gets or sets the number of user-defined questions that are allowed by the policy.

  • Type:
  • int
  • Access:
  • Read/Write

UserQuestionMinLength

Gets or sets the minimum length of a user-defined question.

  • Type:
  • int
  • Access:
  • Read/Write

AnswerMinLengthEnabled

Gets or sets a value that indicates whether user's answers are limited by minimum length.

  • Type:
  • bool
  • Access:
  • Read/Write

AnswerMinLength

Gets or sets the minimum length of a user's answer.

  • Type:
  • int
  • Access:
  • Read/Write

IdenticalAnswersAllowed

Gets or sets a value that indicates whether a user is allowed to provide identical answers to two or more questions.

  • Type:
  • bool
  • Access:
  • Read/Write

AnswersAreCaseSensitive

Gets or sets a value that indicates whether user's answers are case sensitive.

  • Type:
  • bool
  • Access:
  • Read/Write

AnswerCannotBePartOfQuestion

Gets or sets a value that indicates whether an answer can be a part of the question.

  • Type:
  • bool
  • Access:
  • Read/Write

SmsVerificationEnabled

Gets or sets a value that indicates whether the SMS Verification feature is enabled for the Self-Password Reset process.

  • Type:
  • bool
  • Access:
  • Read/Write

SmsVerificationMessage

Gets or sets a template for the SMS verification message. You can use value references in the template (e.g. %username%, %department%). Value references will be replaced with corresponding property values of the user account.

  • Type:
  • string
  • Access:
  • Read/Write

Remarks

The message template must contain the %verificationcode% value reference. This value reference will be replaced with the verification code.

SmsVerificationNoMobileNumberBypassed

Gets or sets a value that indicates whether SMS verification is bypassed when a user does not have a mobile number assigned.

  • Type:
  • bool
  • Access:
  • Read/Write

BlockAccountInvalidAttemptsEnabled

Gets or sets a value that indicates whether a user account is blocked from using the Self-Password Reset feature.

  • Type:
  • bool
  • Access:
  • Read/Write

BlockAccountInvalidAttemptsNumber

Gets or sets the number of invalid attempts a user must make before their account is blocked from using the Self-Password Reset feature.

  • Type:
  • int
  • Access:
  • Read/Write

ResetFailedAttemptsEnabled

Gets or sets a value that indicates whether the invalid attempts counter is reset automatically after a period of time specified by the ResetFailedAttemptsTimespan property.

  • Type:
  • int
  • Access:
  • Read/Write

ResetFailedAttemptsTimespan

Gets or sets the number of seconds after which the invalid attempts counter will be reset for the user automatically.

  • Type:
  • int
  • Access:
  • Read/Write

AutoUnblockAccountEnabled

Gets or sets a value that indicates whether a blocked account will be automatically unblocked after a period of time specified by the AutoUnblockAccountTimespan property.

  • Type:
  • bool
  • Access:
  • Read/Write

AutoUnblockAccountTimespan

Gets or sets the number of seconds after which a blocked account will be unblocked automatically.

  • Type:
  • int
  • Access:
  • Read/Write

UnlockAccountEnabled

Gets or sets a value that indicates whether a user can unlock their account during Self-Password Reset.

  • Type:
  • bool
  • Access:
  • Read/Write

EnrollmentInvitationEnabled

Gets or sets a value that indicates whether enrollment invitations will be sent to users affected by this policy.

  • Type:
  • bool
  • Access:
  • Read/Write

EnrollmentInvitationSubject

Gets or sets the subject of the enrollment invitation email. You can use value references in the subject (e.g. %name%, %department%). Value references will be replaced with corresponding property values of the user account.

  • Type:
  • string
  • Access:
  • Read/Write

EnrollmentInvitationText

Gets or sets the text of the enrollment invitation email. You can use value references in the text (e.g. %name%, %department%). Value references will be replaced with corresponding property values of the user account.

  • Type:
  • string
  • Access:
  • Read/Write

EnrollmentInvitationFrequency

Gets or sets a value indicating how often enrollment invitations will be sent.

PasswordResetNotificationEnabled

Gets or sets a value that indicates whether a notification must be sent to a user when the Self-Password Reset process is completed.

  • Type:
  • bool
  • Access:
  • Read/Write

PasswordResetNotificationSubject

Gets or sets the subject of the password reset notification. You can use value references in the subject (e.g. %name%, %department%). Value references will be replaced with corresponding property values of the user account.

  • Type:
  • string
  • Access:
  • Read/Write

PasswordResetNotificationText

Gets or sets the text of the password reset notification. You can use value references in the text (e.g. %name%, %department%). Value references will be replaced with corresponding property values of the user account.

  • Type:
  • string
  • Access:
  • Read/Write

CaptchaEnabled

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

  • Type:
  • bool
  • Access:
  • Read/Write

AutoReenrollmentEnabled

Gets or sets a value that indicates whether an enrolled account that doesn't meet the current policy will be forced to re-enroll.

  • Type:
  • bool
  • Access:
  • Read/Write

ActivityScopeItems

Gets a collection of scope items that represents the activity scope of the Password Self-Service Policy. Each item in the collection is represented by the IAdmActivityScopeItem interface. For more information, see Defining the scope of activity

Priority

Gets or sets a value that specifies the priority of the policy. This value is used to identify which policy to be used when more than one policy is applied to a user.

  • Type:
  • int
  • Access:
  • Read/Write

Enabled

Gets or sets a value that indicates whether the Password Self-Service Policy is enabled.

  • Type:
  • bool
  • Access:
  • Read/Write

Requirements

Minimum required version: 2011.3

See also

© Softerra 2022. All rights reserved.
Send feedback