IActivatableByAdmin
extends
IProvider
in
Marks a 2FA provider as activatable by the administrator. This means that an admin can activate this provider without user interaction. The provider, therefore, must not require any user-provided configuration.
Tags
Table of Contents
Methods
- enableFor() : void
- Enable this provider for the given user.
- getDescription() : string
- Get the description for selecting the 2FA provider
- getDisplayName() : string
- Get the display name for selecting the 2FA provider
- getId() : string
- Get unique identifier of this 2FA provider
- getTemplate() : Template
- Get the template for rending the 2FA provider view
- isTwoFactorAuthEnabledForUser() : bool
- Decides whether 2FA is enabled for the given user
- verifyChallenge() : bool
- Verify the given challenge
Methods
enableFor()
Enable this provider for the given user.
public
enableFor(IUser $user) : void
Parameters
- $user : IUser
-
the user to activate this provider for
Tags
getDescription()
Get the description for selecting the 2FA provider
public
getDescription() : string
Example: "Get a token via e-mail"
Tags
Return values
stringgetDisplayName()
Get the display name for selecting the 2FA provider
public
getDisplayName() : string
Example: "Email"
Tags
Return values
stringgetId()
Get unique identifier of this 2FA provider
public
getId() : string
Tags
Return values
stringgetTemplate()
Get the template for rending the 2FA provider view
public
getTemplate(IUser $user) : Template
Parameters
- $user : IUser
Tags
Return values
TemplateisTwoFactorAuthEnabledForUser()
Decides whether 2FA is enabled for the given user
public
isTwoFactorAuthEnabledForUser(IUser $user) : bool
Parameters
- $user : IUser
Tags
Return values
boolverifyChallenge()
Verify the given challenge
public
verifyChallenge(IUser $user, string $challenge) : bool
Parameters
- $user : IUser
- $challenge : string