import * as React from 'react'; import { mfaService } from '../apps'; import { MiscTypes } from '@oneblink/types'; type MfaState = { isExternalIdentityProviderUser: boolean; isLoading: boolean; isMfaEnabled: boolean; mfaSettings: mfaService.MfaSettings; isSetupSuccessOpen: boolean; loadingError?: Error; isSettingUpMfa: boolean; settingUpMfaMethod?: mfaService.MfaMethod; isSetupMethodDialogOpen: boolean; disablingMfaMethod?: mfaService.MfaMethod; isSettingPreferredMfaMethod: boolean; setupError?: Error; mfaAuthenticatorAppSetup?: Awaited>; isPhoneNumberDialogOpen: boolean; phoneVerificationCodeSentAt?: number; isRemovePhoneNumberDialogOpen: boolean; }; export declare const MfaContext: React.Context Promise; openMfaSetupMethodDialog: () => void; closeMfaSetupMethodDialog: () => void; beginDisablingMfaMethod: (mfaMethod: mfaService.MfaMethod) => void; setPreferredMfaMethod: (mfaMethod: mfaService.MfaMethod) => Promise; openPhoneNumberDialog: () => void; closePhoneNumberDialog: () => void; savePhoneNumber: (phoneNumber: string) => Promise; verifyPhoneNumber: (code: string) => Promise; beginRemovingPhoneNumber: () => void; cancelRemovingPhoneNumber: () => void; completeRemovingPhoneNumber: () => Promise; hideSetupSuccess: () => void; cancelMfaAuthenticatorAppSetup: () => void; completeMfaAuthenticatorAppSetup: () => Promise; cancelDisablingMfa: () => void; completeDisablingMfa: () => Promise; clearMfaSetupError: () => void; loadMfa: () => void; }>; /** * React Component that provides the context for the * `useUserMeetsMfaRequirement()` hook and `` * component, to be used by components further down your component tree. **It * should only be included in your component tree once and ideally at the root * of the application.** * * #### Example * * ```js * import * as React from 'react' * import { * MfaProvider, * useUserMeetsMfaRequirement, * } from '@oneblink/apps-react' * * function Component({ teamMemberMfaRequirement }) { * const { mfaSetupRequired, isLoading, loadingError, refreshMfa } = * useUserMeetsMfaRequirement(teamMemberMfaRequirement) * * if (isLoading) { * return * } * * if (loadingError) { * return * } * * if (mfaSetupRequired) { * return * } * * return * } * * function App({ teamMemberMfaRequirement }) { * return ( * * * * ) * } * * const root = document.getElementById('root') * if (root) { * ReactDOM.render(, root) * } * ``` * * @param props * @returns * @group Components */ export declare function MfaProvider({ children, isExternalIdentityProviderUser, authenticatorAppDisplayName, }: { children: React.ReactNode; isExternalIdentityProviderUser: boolean; /** * Name shown in authenticator apps when a user sets up an authenticator. * When omitted, the product name is used. Console sign-in omits this so it * continues to show the product name. */ authenticatorAppDisplayName?: string; }): import("react/jsx-runtime").JSX.Element; export default function useMfa(): MfaState & { authenticatorAppDisplayName?: string; beginMfaSetup: (mfaMethod: mfaService.MfaMethod) => Promise; openMfaSetupMethodDialog: () => void; closeMfaSetupMethodDialog: () => void; beginDisablingMfaMethod: (mfaMethod: mfaService.MfaMethod) => void; setPreferredMfaMethod: (mfaMethod: mfaService.MfaMethod) => Promise; openPhoneNumberDialog: () => void; closePhoneNumberDialog: () => void; savePhoneNumber: (phoneNumber: string) => Promise; verifyPhoneNumber: (code: string) => Promise; beginRemovingPhoneNumber: () => void; cancelRemovingPhoneNumber: () => void; completeRemovingPhoneNumber: () => Promise; hideSetupSuccess: () => void; cancelMfaAuthenticatorAppSetup: () => void; completeMfaAuthenticatorAppSetup: () => Promise; cancelDisablingMfa: () => void; completeDisablingMfa: () => Promise; clearMfaSetupError: () => void; loadMfa: () => void; }; /** * React hook to determine whether the logged in user must set up MFA before * accessing your application. Reads MFA settings from the `` * context. Will throw an Error if used outside of ``. * * Users signed in via an external identity provider are not required to set up * MFA. * * #### Example * * ```js * import { MfaProvider, useUserMeetsMfaRequirement } from '@oneblink/apps-react' * * function Component({ teamMemberMfaRequirement }) { * const { mfaSetupRequired, isLoading, loadingError, refreshMfa } = * useUserMeetsMfaRequirement(teamMemberMfaRequirement) * * if (isLoading) { * return * } * * if (loadingError) { * return * } * * if (mfaSetupRequired) { * return * } * * return * } * ``` * * @param mfaRequirement - The MFA requirement to enforce, e.g. from your * organisation or app settings. * @returns Whether MFA setup is required, along with loading state from the MFA * provider. * @group Hooks */ export declare function useUserMeetsMfaRequirement(mfaRequirement: MiscTypes.MfaRequirement | undefined): { mfaSetupRequired: boolean; isLoading: boolean; loadingError: Error | undefined; refreshMfa: () => void; }; export {};