@aws-amplify/auth
Version:
Auth category of aws-amplify
13 lines (12 loc) • 615 B
TypeScript
import { AmplifyContext } from '@aws-amplify/core';
import { FetchMFAPreferenceOutput } from '../types';
export declare function fetchMFAPreference(ctx: AmplifyContext): Promise<FetchMFAPreferenceOutput>;
/**
* Fetches the preferred MFA setting and enabled MFA settings for the user.
*
* @returns FetchMFAPreferenceOutput
* @throws -{@link GetUserException} : error thrown when the service fails to fetch MFA preference
* and settings.
* @throws AuthTokenConfigException - Thrown when the token provider config is invalid.
*/
export declare function fetchMFAPreference(): Promise<FetchMFAPreferenceOutput>;