Detailed Description
Holds the result of a time based one time passcode (OTP) login attempt.
Also provides access to MFA protocol version and emergency codes remaining.
Availability
Available in version 7.3.5 of Decoder SDK. Requires a server version greater than 7.3.5
#include <MFALoginResponse.h>
Public Member Functions | |
| DB_EDGEVIS_SDK std::vector< MFAVersion > | SupportedProtocols () const |
| Retrieve the list of supported MFA protocols tha may be used for an MFA login request. More... | |
| DB_EDGEVIS_SDK bool | EnrolmentRequired () const |
| Determine if the current user account is required to complete MFA enrolment before being permitted to complete log in. More... | |
| DB_EDGEVIS_SDK std::wstring | EnrolmentPath () const |
| Retrieve a URL to a web page on the server where the user can enrol for MFA. More... | |
| DB_EDGEVIS_SDK int32_t | EmergencyCodesLeft () const |
| Provides the number of emergency codes still available after logging in using an emergency code. More... | |
| DB_EDGEVIS_SDK std::wstring | MFAPasscodeValidationRegex () const |
| Retrieve a regex to allow MFA passcode validation for the MFA version in use. More... | |
| DB_EDGEVIS_SDK MFAVersion | Version () const |
| Determine the MFA version being used to log in to the server. More... | |
Member Function Documentation
| DB_EDGEVIS_SDK std::vector<MFAVersion> EdgeVisDecoderSDK::MFALoginResponse::SupportedProtocols | ( | ) | const |
Retrieve the list of supported MFA protocols tha may be used for an MFA login request.
- Returns
- A vector containing the MFAVersion of ech of the supported protocols.
| DB_EDGEVIS_SDK bool EdgeVisDecoderSDK::MFALoginResponse::EnrolmentRequired | ( | ) | const |
Determine if the current user account is required to complete MFA enrolment before being permitted to complete log in.
- Returns
- True if the current user has to enrol for MFA, false if the user is already enroled or the account is not MFA enabled.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::MFALoginResponse::EnrolmentPath | ( | ) | const |
Retrieve a URL to a web page on the server where the user can enrol for MFA.
- Returns
- True if the current user has to enrol for MFA, false if the user is already enroled or the account is not MFA enabled.
| DB_EDGEVIS_SDK int32_t EdgeVisDecoderSDK::MFALoginResponse::EmergencyCodesLeft | ( | ) | const |
Provides the number of emergency codes still available after logging in using an emergency code.
- Returns
- The number of emergency codes still available to this uer account. If this number reaches 0 (ie. the last emergency code has been used) the user must re-enrol for MFA to obtain new emergency codes.
| DB_EDGEVIS_SDK std::wstring EdgeVisDecoderSDK::MFALoginResponse::MFAPasscodeValidationRegex | ( | ) | const |
Retrieve a regex to allow MFA passcode validation for the MFA version in use.
- Returns
- A string containing a regex to validate the MFA passcode being submitted when logging in.
| DB_EDGEVIS_SDK MFAVersion EdgeVisDecoderSDK::MFALoginResponse::Version | ( | ) | const |
Determine the MFA version being used to log in to the server.
- Returns
- An enum containing the MFA version in use.
The documentation for this class was generated from the following file:
- SDKs/EdgeVisDecoderSDK/MFALoginResponse.h