IProvider¶
-
interface
OCP\Authentication\TwoFactorAuth\
IProvider
¶ Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#35
Constants¶
-
EVENT_SUCCESS = self::class . ::success
Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#41 Since: 14.0.0 Deprecated: 22.0.0
-
EVENT_FAILED = self::class . ::failed
Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#46 Deprecated: 22.0.0
Methods¶
-
public
OCP\Authentication\TwoFactorAuth\IProvider::
getId
()¶ - Get unique identifier of this 2FA provider
Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#55 Since: 9.1.0 Returns: string
-
public
OCP\Authentication\TwoFactorAuth\IProvider::
getDisplayName
()¶ - Get the display name for selecting the 2FA providerExample: “Email”
Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#66 Since: 9.1.0 Returns: string
-
public
OCP\Authentication\TwoFactorAuth\IProvider::
getDescription
()¶ - Get the description for selecting the 2FA providerExample: “Get a token via e-mail”
Source: lib/public/Authentication/TwoFactorAuth/IProvider.php#77 Since: 9.1.0 Returns: string
-
public
OCP\Authentication\TwoFactorAuth\IProvider::
getTemplate
($user)¶ - Get the template for rending the 2FA provider view
Source: Parameters: - $user (
OCP\IUser
)
Since: 9.1.0
Returns: - $user (
-
public
OCP\Authentication\TwoFactorAuth\IProvider::
verifyChallenge
($user, $challenge)¶ - Verify the given challenge
Source: Parameters: - $user (
OCP\IUser
) - $challenge (string)
Since: 9.1.0
Returns: bool
- $user (