@cfxlabsinc/b2b-services
    Preparing search index...

    Interface CognitoSignInCore

    interface CognitoSignInCore {
        answerPasskey(
            input: { challenge: CognitoSignInChallenge; credential: string },
        ): Promise<CognitoSignInStepOutcome>;
        confirmEmail(
            input: {
                code: string;
                email: string;
                inviteId?: string;
                password?: string;
            } & BrowserTimeZone,
        ): Promise<CognitoSignInStepOutcome>;
        confirmPasswordReset(
            input: { code: string; email: string; password: string } & BrowserTimeZone,
        ): Promise<CognitoSignInStepOutcome>;
        currentStep(): Promise<
            SignInOutcome<
                {
                    step: | "profile"
                    | "create-passkey"
                    | "no-workspace"
                    | "done"
                    | "credentials";
                },
            >,
        >;
        findSingleSignOn(
            input: { email: string },
        ): Promise<SignInOutcome<{ identityProvider: string | null }>>;
        findWaysIn(
            input: { email: string },
        ): Promise<
            SignInOutcome<
                {
                    google: boolean;
                    identityProvider: string
                    | null;
                    password: boolean;
                },
            >,
        >;
        finishPasskeySetup(
            input: { credential: string },
        ): Promise<CognitoSignInStepOutcome>;
        finishTotpSetup(
            input: { challenge: CognitoSignInChallenge; code: string },
        ): Promise<CognitoSignInStepOutcome>;
        logIn(
            input: { email: string; password: string } & BrowserTimeZone,
        ): Promise<CognitoSignInStepOutcome>;
        requestPasswordReset(
            input: { email: string },
        ): Promise<SignInOutcome<{ identityProvider: string | null }>>;
        resendConfirmation(input: { email: string }): Promise<SignInOutcome>;
        savePhoneNumber(
            input: { phoneNumber: string },
        ): Promise<CognitoSignInStepOutcome>;
        setNewPassword(
            input: { challenge: CognitoSignInChallenge; password: string },
        ): Promise<CognitoSignInStepOutcome>;
        signUp(
            input: SignUpInput & BrowserTimeZone,
        ): Promise<CognitoSignInStepOutcome>;
        startPasskey(
            input: { email: string } & BrowserTimeZone,
        ): Promise<CognitoSignInStepOutcome>;
        startPasskeySetup(): Promise<SignInOutcome<CognitoPasskeySetup>>;
        startTotpSetup(
            input: { challenge: CognitoSignInChallenge; email: string },
        ): Promise<
            SignInOutcome<
                {
                    challenge: CognitoSignInChallenge;
                    qrPngBase64: string;
                    secret: string;
                },
            >,
        >;
        verifyTotp(
            input: { challenge: CognitoSignInChallenge; code: string },
        ): Promise<CognitoSignInStepOutcome>;
    }
    Index
    answerPasskey confirmEmail confirmPasswordReset currentStep findSingleSignOn findWaysIn finishPasskeySetup finishTotpSetup logIn requestPasswordReset resendConfirmation savePhoneNumber setNewPassword signUp startPasskey startPasskeySetup startTotpSetup verifyTotp

    • Parameters

      • input: { code: string; email: string; inviteId?: string; password?: string } & BrowserTimeZone
        • code: string
        • email: string
        • OptionalinviteId?: string
        • Optionalpassword?: string

          Sign-up's password, where its next step said setsPassword.

      Returns Promise<CognitoSignInStepOutcome>

    • Where the app's own session stands; credentials when there is none.

      Returns Promise<
          SignInOutcome<
              {
                  step: | "profile"
                  | "create-passkey"
                  | "no-workspace"
                  | "done"
                  | "credentials";
              },
          >,
      >

    • The ways in the address has. identityProvider is its domain's tenant IdP, found before Cognito is asked; an unknown address answers as password.

      Parameters

      • input: { email: string }

      Returns Promise<
          SignInOutcome<
              { google: boolean; identityProvider: string
              | null; password: boolean },
          >,
      >

    Settings
    Member Visibility

    On This Page
    Methods