verifyMFA

Updated:
Supported Platforms:
UUX

Token handling for External MFA extensions

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.

For more information on External MFA, please visit the Caliper SDK documentation.

Details

Type

tecton.sources.verifyMFA(options: { token: string, exit?: boolean }): Promise<any>;

Example

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

Arguments

UUX

Token value created by the extension to be passed for verification. Must be passed unless attempting to force exit.

UUX

Option to tell platform to exit out of MFA flow if there is an issue with authentication. Can be passed instead of token.

Release Notes

Initial Release