@oneblink/apps-react
    Preparing search index...

    Function useUserMeetsMfaRequirement

    • React hook to determine whether the logged in user must set up MFA before accessing your application. Reads MFA settings from the <MfaProvider /> context. Will throw an Error if used outside of <MfaProvider />.

      Users signed in via an external identity provider are not required to set up MFA.

      import { MfaProvider, useUserMeetsMfaRequirement } from '@oneblink/apps-react'

      function Component({ teamMemberMfaRequirement }) {
      const { mfaSetupRequired, isLoading, loadingError, refreshMfa } =
      useUserMeetsMfaRequirement(teamMemberMfaRequirement)

      if (isLoading) {
      return <Loading />
      }

      if (loadingError) {
      return <Error onRetry={refreshMfa} />
      }

      if (mfaSetupRequired) {
      return <ConfigureMfa />
      }

      return <Application />
      }

      Parameters

      • mfaRequirement: MfaRequirement | undefined

        The MFA requirement to enforce, e.g. from your organisation or app settings.

      Returns {
          isLoading: boolean;
          loadingError: Error | undefined;
          mfaSetupRequired: boolean;
          refreshMfa: () => void;
      }

      Whether MFA setup is required, along with loading state from the MFA provider.