Click or drag to resize
MFAuthenticationHelper Class
Helper for multi-factor authentication
Inheritance Hierarchy
SystemObject
  CMS.BaseCoreMethods
    CMS.BaseAbstractHelper
      CMS.BaseAbstractHelperMFAuthenticationHelper
        CMS.MembershipMFAuthenticationHelper

Namespace: CMS.Membership
Assembly: CMS.Membership (in CMS.Membership.dll) Version: 12.0.0
Syntax
C#
public class MFAuthenticationHelper : AbstractHelper<MFAuthenticationHelper>

The MFAuthenticationHelper type exposes the following members.

Constructors
  NameDescription
Public methodMFAuthenticationHelper
Top
Properties
  NameDescription
Protected propertyClockDriftTolerance
Tolerated clock drift between client and server.
Public propertyStatic memberDisplaySetupCode
Indicates whether the setup code is showed to the user after enabling MFA.
Protected propertyHashAlgorithm
Underlying hash algorithm used by the passcode generator.
Public propertyStatic memberIsMultiFactorAuthEnabled
Indicates whether MFA is enabled.
Public propertyStatic memberIsMultiFactorAuthRequired
Indicates whether MFA is forced.
Protected propertyPasscodeLength
Length of the passcode.
Top
Methods
  NameDescription
Public methodStatic memberGetSetupCodeForUser
Returns the setup code that should be used to synchronize with the user's authenticator.
Protected methodGetSetupCodeForUserInternal
Returns the setup code that should be used to synchronize with the user's authenticator.
Public methodStatic memberIsMultiFactorRequiredForUser
Indicates whether MFA is required for the given user.
Protected methodIsMultiFactorRequiredForUserInternal
Indicates whether MFA is required for the given user.
Public methodStatic memberIsPasscodeValid
Checks whether the entered passcode is valid.
Protected methodIsPasscodeValidInternal
Checks whether the entered passcode is valid.
Public methodStatic memberIssuePasscode
Fires the MultiFactorAuthenticate event. Generates a new secret in case the user has none.
Protected methodIssuePasscodeInternal
Fires the MultiFactorAuthenticate event. Generates a new secret in case the user has none.
Public methodStatic memberResetSecretForUser
Resets the user's current MFA information.
Protected methodResetSecretForUserInternal
Resets the user's current MFA information.
Public methodSetAsDefaultHelper
Sets this object as the default helper
(Inherited from AbstractHelperHelperType.)
Top
See Also