Function AccountAccess

Parameters

• __namedParameters: {
      client: {
          confirmEmailChange: (
              body: EmailChangeConfirmRequest,
          ) => Promise<Record<string, string>>;
          getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>;
          getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>;
          login: (body: UserLoginRequest) => Promise<AccountLoginResponse>;
          logout: () => Promise<Record<string, string>>;
          register: (
              body: ShopUserProfileCreateRequest,
          ) => Promise<Record<string, string>>;
          requestPasswordReset: (
              body: PasswordResetRequest,
          ) => Promise<Record<string, string>>;
          setPassword: (
              body: PasswordResetConfirmRequest,
          ) => Promise<Record<string, string>>;
          verifyEmail: (
              body: EmailVerificationRequest,
          ) => Promise<Record<string, string>>;
      };
      onAuthenticated: () => void;
      onGuest?: () => void;
      privacyUrl?: string;
      returnPath: string;
      termsUrl?: string;
  }

  • client: {
        confirmEmailChange: (
            body: EmailChangeConfirmRequest,
        ) => Promise<Record<string, string>>;
        getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>;
        getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>;
        login: (body: UserLoginRequest) => Promise<AccountLoginResponse>;
        logout: () => Promise<Record<string, string>>;
        register: (
            body: ShopUserProfileCreateRequest,
        ) => Promise<Record<string, string>>;
        requestPasswordReset: (
            body: PasswordResetRequest,
        ) => Promise<Record<string, string>>;
        setPassword: (
            body: PasswordResetConfirmRequest,
        ) => Promise<Record<string, string>>;
        verifyEmail: (
            body: EmailVerificationRequest,
        ) => Promise<Record<string, string>>;
    }

    Stable client instance used for API requests.

    • confirmEmailChange: (body: EmailChangeConfirmRequest) => Promise<Record<string, string>>

      Confirm a one-time email change token.

    • getProfile: (signal?: AbortSignal) => Promise<ShopUserProfile>

      Load the authoritative authenticated profile. Optional signal cancels the read.

    • getSettings: (signal?: AbortSignal) => Promise<PublicShopSettings>

      Read public installation settings. Optional signal cancels the request.

    • login: (body: UserLoginRequest) => Promise<AccountLoginResponse>

      Sign in through the host proxy; browser JSON must omit upstream access tokens.

    • logout: () => Promise<Record<string, string>>

      Invalidate the current host session.

    • register: (body: ShopUserProfileCreateRequest) => Promise<Record<string, string>>

      Request registration without revealing account existence.

    • requestPasswordReset: (body: PasswordResetRequest) => Promise<Record<string, string>>

      Request a reset email without revealing account existence.

    • setPassword: (body: PasswordResetConfirmRequest) => Promise<Record<string, string>>

      Set the account password from a one-time token.

    • verifyEmail: (body: EmailVerificationRequest) => Promise<Record<string, string>>

      Confirm a one-time email verification token.

  • onAuthenticated: () => void

    Refresh the host session after successful authentication.

  • OptionalonGuest?: () => void

    Continue in the host guest flow when supplied. Optional; omitted unless supplied by the host or backend.

  • OptionalprivacyUrl?: string

    Host privacy policy URL.

    Default Value

    "/datenschutz"
    Copy

  • returnPath: string

    Safe same-origin path to visit after account authentication.

  • OptionaltermsUrl?: string

    Host terms and conditions URL.

    Default Value

    "/agb"
    Copy