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

    Class DashboardAccountSecurityService

    A customer or bank dashboard user's own sign-in credentials, on their Cognito login. Each change publishes auth.dashboardUser.* once Cognito has accepted it; the reads and the two-step starts pass through unchanged. A login with no dashboard user (CFX staff) changes and publishes nothing.

    Implements

    • AccountSecurityClient
    Index
    constructor
    associateUserSoftwareToken changePassword completeWebAuthnRegistration deleteWebAuthnCredential getUser listWebAuthnCredentials preferSoftwareTokenMfa startWebAuthnRegistration verifyUserSoftwareToken
    signOutEverywhere
    associateUserSoftwareToken: (
        __namedParameters: AccessTokenInput,
    ) => Promise<
        | { error: CognitoAuthError; ok: false }
        | { ok: true; value: { secretCode: string } },
    > = ...

    A new TOTP secret for the signed-in user. The current one keeps working until verifyUserSoftwareToken accepts a code from this one.

    changePassword: (
        __namedParameters: AccessTokenInput & {
            previousPassword: string;
            proposedPassword: string;
        },
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: void },
    > = ...

    A wrong previousPassword returns NOT_AUTHORIZED.

    completeWebAuthnRegistration: (
        __namedParameters: AccessTokenInput & { credential: string },
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: void },
    > = ...

    credential is WebAuthn RegistrationResponseJSON, as a JSON string.

    deleteWebAuthnCredential: (
        __namedParameters: AccessTokenInput & { credentialId: string },
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: void },
    > = ...
    getUser: (
        __namedParameters: AccessTokenInput,
    ) => Promise<
        | { error: CognitoAuthError; ok: false }
        | { ok: true; value: { totpEnabled: boolean } },
    > = ...

    Whether the signed-in user has TOTP turned on (GetUser's UserMFASettingList).

    listWebAuthnCredentials: (
        __namedParameters: AccessTokenInput,
    ) => Promise<
        | { error: CognitoAuthError; ok: false }
        | { ok: true; value: CognitoPasskey[] },
    > = ...

    Every passkey the signed-in user has, across all pages.

    preferSoftwareTokenMfa: (
        __namedParameters: AccessTokenInput,
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: void },
    > = ...

    Turns TOTP on as the user's preferred MFA.

    startWebAuthnRegistration: (
        __namedParameters: AccessTokenInput,
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: string },
    > = ...

    WebAuthn PublicKeyCredentialCreationOptionsJSON, as a JSON string.

    verifyUserSoftwareToken: (
        __namedParameters: AccessTokenInput & { code: string },
    ) => Promise<
        { error: CognitoAuthError; ok: false }
        | { ok: true; value: void },
    > = ...

    The authenticator app's replacement completes when its first code verifies.

    Type Declaration

      • (
            __namedParameters: AccessTokenInput & { code: string },
        ): Promise<
            { error: CognitoAuthError; ok: false }
            | { ok: true; value: void },
        >

      • Checks a code from the newly associated secret, which then replaces the old one.

        Parameters

        • __namedParameters: AccessTokenInput & { code: string }

        Returns Promise<{ error: CognitoAuthError; ok: false } | { ok: true; value: void }>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Methods