verifyMFA

Updated:

Token handling for External MFA extensions.

Description

verifyMFA is a capability for use when writing External MFA extensions with the Q2 SDK. At the completion of External MFA within the extension, a token can be passed to the platform for verification. If verification is successful, the platform can respond back to the calling extension with a successful promise and transition to the next step in the platform's workflow.

Signature

tecton.actions.verifyMFA(options: VerifyMFAOptions): Promise<any>;
export interface VerifyMFAOptions {
    token: string;
    exit?: boolean;
}

Usage

Verify an MFA token.

tecton.actions.verifyMFA({
    token: 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IlRFQ1RPTiIsImlhdCI6MTUxNjIzOTAyMn0.Ul0KK6P0ZSzr6Av2LPGXoFQSmgQjL90EoDdwX7i9pGc'
}).then(function (response) {
    // Handle verifyMFA success response
}).catch(function (error) {
    // Handle verifyMFA error response
});

Additional Information

When using the verifyMFA action, there are important details to keep in mind.

External MFA

verifyMFA is intended to be used with External MFA extensions built using the Q2 Caliper SDK. For more information on building External MFA extensions, see the SDK External MFA guide.

Parameters

options.token
options.exit

Release Notes

Tecton
1.43.0

Platform Support

UUX