View Source

Interface ITwoFactorProvider

A two factor provider

Namespace: Umbraco.Cms.Core.Security
Assembly: Umbraco.Core.dll
Syntax
public interface ITwoFactorProvider

Properties

View Source

ProviderName

A unique name for this provider.

Declaration
string ProviderName { get; }
Property Value
Type Description
string

Methods

View Source

GetSetupDataAsync(Guid, string)

Gets the data needed to setup this provider. Using the marker interface ISetupTwoFactorModel.

Declaration
Task<ISetupTwoFactorModel> GetSetupDataAsync(Guid userOrMemberKey, string secret)
Parameters
Type Name Description
Guid userOrMemberKey
string secret
Returns
Type Description
Task<ISetupTwoFactorModel>
View Source

ValidateTwoFactorPIN(string, string)

Validates the 2FA login token for the user identified by the supplied secret.

Declaration
bool ValidateTwoFactorPIN(string secret, string token)
Parameters
Type Name Description
string secret
string token
Returns
Type Description
bool
View Source

ValidateTwoFactorSetup(string, string)

Validates the 2FA setup token for the user identified by the supplied secret.

Declaration
bool ValidateTwoFactorSetup(string secret, string token)
Parameters
Type Name Description
string secret
string token
Returns
Type Description
bool
Remarks

Called to confirm the setup of two factor on the user.