TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface Interface Reference

Inheritance diagram for TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface:

Public Member Functions
string	getIdentifier ()
string	getTitle ()
string	getDescription ()
string	getSetupInstructions ()
string	getIconIdentifier ()
bool	isDefaultProviderAllowed ()
‪Public Member Functions inherited from ‪TYPO3\CMS\Core\Authentication\Mfa\MfaProviderInterface
bool	canProcess (ServerRequestInterface $request)
bool	isActive (MfaProviderPropertyManager $propertyManager)
bool	isLocked (MfaProviderPropertyManager $propertyManager)
bool	verify (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
ResponseInterface	handleRequest (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager, string $type)
bool	activate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
bool	deactivate (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
bool	unlock (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)
bool	update (ServerRequestInterface $request, MfaProviderPropertyManager $propertyManager)

Detailed Description

Annotated information about the MFA provider – used in various views

should only be used by the TYPO3 Core

Definition at line 25 of file MfaProviderManifestInterface.php.

Member Function Documentation

getDescription()

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::getDescription

(

)

A short description about the provider

Returns

‪string

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

getIconIdentifier()

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::getIconIdentifier

(

)

The icon identifier for this provider

Returns

‪string

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

getIdentifier()

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::getIdentifier

(

)

Unique provider identifier

Returns

‪string

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderPropertyManager\create(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\isDefaultProvider(), TYPO3\CMS\Core\Authentication\Mfa\MfaProviderRegistry\registerProvider(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\setDefaultProvider(), and TYPO3\CMS\Backend\Controller\MfaController\verifyAction().

getSetupInstructions()

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::getSetupInstructions

(

)

Instructions to be displayed in the setup view

Returns

‪string

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

getTitle()

string TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::getTitle

(

)

The title of the provider

Returns

‪string

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\deactivateAction(), TYPO3\CMS\Backend\Controller\MfaConfigurationController\saveAction(), and TYPO3\CMS\Backend\Controller\MfaConfigurationController\unlockAction().

isDefaultProviderAllowed()

bool TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifestInterface::isDefaultProviderAllowed

(

)

Whether the provider is allowed to be set as default

Returns

‪bool

Implemented in TYPO3\CMS\Core\Authentication\Mfa\MfaProviderManifest.

Referenced by TYPO3\CMS\Backend\Controller\MfaConfigurationController\activateAction().