Nucleus .Net Core CMS

Authentication.IMfaProvider Interface

Namespace: Nucleus.Abstractions.Authentication
Assembly: Nucleus.Abstractions.dll
Base class for multi-factor authentication (MFA) providers.
BeginAddUserConfiguration (Site site, User user, UserMfaProviderConfiguration config)
Displays the user interface for creating a new user configuration for the MFA provider.
BeginChallenge (Site site, User user, Guid sessionId, UserMfaProviderConfiguration config, String returnUrl)
Begins the challenge process for the MFA provider (often by displaying a user interface), typically used to verify a user's identity.
BeginEditUserConfiguration (Site site, User user, UserMfaProviderConfiguration config)
Displays the setup user interface for editing the specified MFA provider configuration.
BeginResetUserConfiguration (Site site, User user, UserMfaProviderConfiguration config)
Displays the setup user interface for re-setting the specified MFA provider configuration.
CreateUserConfiguration (Site site, User user)
Creates a new MFA provider user settings object, populated with default values.
GetSiteSettings (Nucleus.Abstractions.Models.Site)
Creates a new instance of the site settings for the MFA provider and populate it from site settings.
GetUserSettings (UserMfaProviderConfiguration userMfaProviderConfiguration)
Creates a new instance of the user settings for the MFA provide and populate values from userMfaProviderConfiguration.
Parameters
Name Type
userMfaProviderConfiguration Nucleus.Abstractions.Models.UserMfaProviderConfiguration

The user MFA provider configuration rows from the database to populate the settings from.

SendChallengeData (Site site, User user, UserMfaProviderConfiguration config)
Executes/sends challenge data for the specified MFA provider's configuration via another channel (not the user interface). For example, send a one-time code to the user's email or phone number.
SetUserSettings (Site site, User user, MfaProviderView viewModel, UserMfaProviderConfiguration userMfaProviderConfiguration)
Populate the specified userMfaProviderConfiguration with values from the specified viewModel.
SiteSettingsView ()
Returns the path/name of the view used to display provider-specific settings for the site.
VerifyChallengeResponse (Site site, User user, MfaProviderChallenge response, UserMfaProviderConfiguration config)
Verifies the challenge response entered during login (often one-time password).
VerifyConfigurationResponse (Site site, User user, MfaProviderView response, UserMfaProviderConfiguration config)
Verifies the challenge response entered during setup (often one-time password).