MethodInterface
interface MethodInterface (View source)
Defines an Authentication Method, which serves as an additional factor for authentication beyond the standard username / password method.
Methods
Get a URL segment for this method. This will be used in URL paths for performing authentication by this method
Return the VerifyHandler that is used to start and check verification attempts with this method
Return the RegisterHandler that is used to perform registrations with this method
Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods
Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified
Returns whether the method is available to be used from a backend perspective.
If not available to be used, provide a message to display on the frontend to explain why.
Details
string
getName()
Provide a localised name for this MFA Method.
eg. "Authenticator app"
string
getURLSegment()
Get a URL segment for this method. This will be used in URL paths for performing authentication by this method
VerifyHandlerInterface
getVerifyHandler()
Return the VerifyHandler that is used to start and check verification attempts with this method
RegisterHandlerInterface
getRegisterHandler()
Return the RegisterHandler that is used to perform registrations with this method
string
getThumbnail()
Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods
void
applyRequirements()
Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified
bool
isAvailable()
Returns whether the method is available to be used from a backend perspective.
string
getUnavailableMessage()
If not available to be used, provide a message to display on the frontend to explain why.