@creator-co/module-identity-client - v2.3.1
    Preparing search index...

    Represents a user in the IDM system.

    Index
    isAutheticating: boolean

    A boolean flag indicating whether the user is currently authenticating.

    • Confirms the verification code sent to the user's email address.

      Parameters

      • userId: string

        The ID of the user to verify the email for.

      • code: string

        The verification code sent to the user's email.

      Returns Promise<any>

      A promise that resolves with the API response.

    • Asynchronously confirms password reset and logs in with the new password.

      Parameters

      • newPassword: string

        The new password to set.

      • code: string

        The verification code for password reset.

      • email: string

        The email address associated with the account.

      Returns Promise<AuthorizationResponse | ErrorResponse>

      A promise that resolves with the response data or an ErrorResponse object.

    • Disables email-based MFA for the given user.

      Parameters

      • userId: string

        The ID of the user to disable email MFA for.

      • password: string

        The current user password used to generate a reauthentication token.

      Returns Promise<any>

      A promise that resolves with the API response.

    • Disables SMS-based MFA for the given user.

      Parameters

      • userId: string

        The ID of the user to disable SMS MFA for.

      Returns Promise<any>

      A promise that resolves with the API response.

    • Enables email-based MFA for the given user.

      Parameters

      • userId: string

        The ID of the user to enable email MFA for.

      Returns Promise<any>

      A promise that resolves with the API response.

    • Enables SMS-based MFA for the given user. Requires the user to have a confirmed phone number on their account.

      Parameters

      • userId: string

        The ID of the user to enable SMS MFA for.

      Returns Promise<any>

      A promise that resolves with the API response.

    • Sends a verification code to the user's email address.

      Parameters

      • userId: string

        The ID of the user to send the verification email to.

      Returns Promise<any>

      A promise that resolves with the API response.