interface MethodInterface (View source)

Defines an Authentication Method, which serves as an additional factor for authentication beyond the standard username / password method.

Methods

public
string
getName()

Provide a localised name for this MFA Method.

public
string
getURLSegment()

Get a URL segment for this method. This will be used in URL paths for performing authentication by this method

public
getVerifyHandler()

Return the VerifyHandler that is used to start and check verification attempts with this method

public
getRegisterHandler()

Return the RegisterHandler that is used to perform registrations with this method

public
string
getThumbnail()

Return a URL to an image to be used as a thumbnail in the MFA login/registration grid for all MFA methods

public
void
applyRequirements()

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

public
bool
isAvailable()

Returns whether the method is available to be used from a backend perspective.

public
string
getUnavailableMessage()

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"

Return Value

string

string getURLSegment()

Get a URL segment for this method. This will be used in URL paths for performing authentication by this method

Return Value

string

VerifyHandlerInterface getVerifyHandler()

Return the VerifyHandler that is used to start and check verification attempts with this method

Return Value

VerifyHandlerInterface

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

Return Value

string

void applyRequirements()

Leverage the Requirements API to ensure client requirements are included. This is called just after the base module requirements are specified

Return Value

void

bool isAvailable()

Returns whether the method is available to be used from a backend perspective.

Return Value

bool

string getUnavailableMessage()

If not available to be used, provide a message to display on the frontend to explain why.

Return Value

string