> ## Documentation Index
> Fetch the complete documentation index at: https://dokumentation.websale.de/llms.txt
> Use this file to discover all available pages before exploring further.

# actions - Sign-in & registration

> Shop actions around sign-in and registration: error texts and email templates for login, account unlocking and password reset in the WEBSALE online shop.

export const TextbausteinHinweis = () => <>
    Dieser Text wird über einen Textbaustein realisiert.<br />
    Alles zu Textbausteinen in Konfigurationen finden Sie{" "}
    <a href="https://dokumentation.websale.de/konfiguration#verwendung-von-textbausteinen-in-konfigurationen">hier</a>.
  </>;

This page contains all actions related to the sign-in and registration process in the online shop. All messages and email templates that are output during sign-in, when unblocking an account, or when resetting a password, etc., are documented here.

***

## Overview of actions

The actions listed here are **grouped thematically** to provide a clear overview of the associated error messages and email templates.

Actions that thematically belong to a different area can be found in the corresponding sections of this documentation or in the [alphabetical overview of actions](/en/konfiguration/actions-fehlertexte-e-mails/actions-alphabetische-ubersicht).

#### Excerpt of the basic `actions` structure

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "actions": {
    "acceptInvitation": {...},
    "checkPasswordStrength": {...},
    "login": {...},
    "unlockLogin": {...},
    "passwordForgotten": {...},
    "resetPassword": {...}
  }
}
```

#### Action overview

| **Action**              | **Description**                                                                                                  |
| ----------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `acceptInvitation`      | Defines the error messages that are output when accepting an invitation to a B2B account.                        |
| `checkPasswordStrength` | Controls whether the shop checks the strength of a password.                                                     |
| `login`                 | Defines the error messages that are output during the sign-in process to a customer account.                     |
| `unlockLogin`           | Defines the error messages that are output when lifting a login block.                                           |
| `passwordForgotten`     | Defines the error messages that are output during the "forgot password" flow, as well as the email that is sent. |
| `resetPassword`         | Defines the error messages that are output when changing the password.                                           |

***

## `actions.acceptInvitation` - Accept invitation (B2B)

The `acceptInvitation` action controls the error messages that are output when an invited user accepts a B2B account invitation via a double opt-in link.

#### **Example configuration**

```text theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "errorCodes": {
    "invalidAccountId": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}
```

#### Parameter overview

| Parameter          | Type   | Description                                                                                                                     |
| ------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------- |
| `errorCodes`       | object | Configures the error codes used for problems during the action.                                                                 |
| `invalidAccountId` | string | Error message output when the double opt-in token cannot be assigned to a customer account. <br /><br /><TextbausteinHinweis /> |
| `actionNotAllowed` | string | Error message output when the double opt-in token is invalid. <br /><br /><TextbausteinHinweis />                               |

***

## `actions.checkPasswordStrength` - Password strength / password security

The `checkPasswordStrength` action controls whether the shop system checks the strength of a password server-side (e.g. minimum length, complexity) during actions such as registration or password change.

#### Example configuration

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "active": true
}
```

#### Parameter overview

| **Parameter** | **Type** | **Description**                                                                     |
| ------------- | -------- | ----------------------------------------------------------------------------------- |
| `active`      | bool     | Enables or disables the server-side password strength check.  <br />Default: `true` |

***

## `actions.login` - Sign-in

The `login` action defines which error messages are output during the sign-in process to a customer account.

#### Example configuration

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "errorCodes": {
    "missingId": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "loginBlocked": "<Textbaustein>",
    "invalidCredentials": "<Textbaustein>",
    "ipAddressBlocked": "<Textbaustein>",
    "duplicatePendingReview": "<Textbaustein>"
  }
}
```

#### Parameter overview

| **Parameter**            | **Type** | **Description**                                                                                                                                                                                                           |
| ------------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `errorCodes`             | array    | Configures the error codes used for problems during the action.                                                                                                                                                           |
| `missingId`              | string   | Error message output when no login ID (e.g. email address) was supplied. <br /><br /><TextbausteinHinweis />                                                                                                              |
| `missingPassword`        | string   | Error message output when no password was supplied. <br /><br /><TextbausteinHinweis />                                                                                                                                   |
| `emailCheckFailed`       | string   | Error message output when the provided email address is considered invalid. <br /><br /><TextbausteinHinweis />                                                                                                           |
| `loginBlocked`           | string   | Error message output when the user account is temporarily blocked. <br /><br /><TextbausteinHinweis />                                                                                                                    |
| `invalidCredentials`     | string   | Error message output when the combination of email address and password is incorrect. <br /><br /><TextbausteinHinweis />                                                                                                 |
| `ipAddressBlocked`       | string   | Error message output when the current IP address is blocked (blacklist). <br /><br /><TextbausteinHinweis />                                                                                                              |
| `duplicatePendingReview` | string   | Error message output when sign-in is not possible because the account is still in duplicate review (see [accounts.account](/en/konfiguration/accounts-benutzerkonten) → `duplicate`). <br /><br /><TextbausteinHinweis /> |

***

## `actions.unlockLogin` - Unblock sign-in

The `unlockLogin` action defines the error messages that are output when lifting a login block for a customer account.

#### Example configuration

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "errorCodes": {
    "unauthorized": "<Textbaustein>"
  }
}
```

#### Parameter overview

| **Parameter**  | **Type** | **Description**                                                                                                                             |
| -------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `errorCodes`   | object   | Configures the error codes used for problems during the action.                                                                             |
| `unauthorized` | string   | Error message output when the unblocking is not permitted (e.g. invalid link or missing authorisation). <br /><br /><TextbausteinHinweis /> |

***

## `actions.passwordForgotten` - Forgot password

The `passwordForgotten` action defines the error messages that are shown during the "forgot password" flow.

#### Example configuration

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "email": {
    "template": "password_forgotten.htm",
    "subject": "Passwort zurücksetzen",
    "fromAddress": "noreply@meinshop.de",
    "fromName": "Mein Onlineshop"
  },
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordRecoveryFailed": "<Textbaustein>"
  }
}
```

#### Parameter overview

| **Parameter**            | **Type** | **Description**                                                                                                                                                                                                   |
| ------------------------ | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `email`                  | object   | Configures the email sent when resetting the password. Subject, sender and template are controlled via the general email parameters, see here:   [Email settings](/en/konfiguration/e-mails-e-mail-einstellungen) |
| `errorCodes`             | object   | Configures the error codes used for problems during the action.                                                                                                                                                   |
| `missingEmail`           | string   | Error message output when no email address was supplied. <br /><br /><TextbausteinHinweis />                                                                                                                      |
| `emailCheckFailed`       | string   | Error message output when the provided email address is considered invalid. <br /><br /><TextbausteinHinweis />                                                                                                   |
| `passwordRecoveryFailed` | string   | Error message output when the password reset fails. <br /><br /><TextbausteinHinweis />                                                                                                                           |

***

## `actions.resetPassword` - Reset password

The `resetPassword` action defines which error messages are output when changing the password for an existing customer account, and which checks/actions are carried out.

#### Example configuration

```json theme={"theme":{"light":"github-light","dark":"github-dark"},"languages":{"custom":["/languages/websale.json"]}}
{
  "autoLogout": true,
  "checkOldPassword": true,
  "checkLoginID": false,
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "emailMismatch": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "missingPasswordAuth": "<Textbaustein>",
    "failedPasswordAuth": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>"
  }
}
```

#### Parameter overview

| **Parameter**         | **Type** | **Description**                                                                                                                      |
| --------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `autoLogout`          | bool     | Determines whether the customer is automatically logged out after a successful password change.   <br />Default: `true`              |
| `checkOldPassword`    | bool     | Indicates whether the previous password is additionally requested and verified when changing the password.   <br />Default: `true`   |
| `checkLoginID`        | bool     | If `true`, an additional check is performed to verify that the supplied login ID/email matches the account.   <br />Default: `false` |
| `errorCodes`          | object   | Configures the error codes used for problems during the action.                                                                      |
| `notLoggedIn`         | string   | Error message output when the user is not signed in. <br /><br /><TextbausteinHinweis />                                             |
| `missingEmail`        | string   | Error message output when no email address was supplied. <br /><br /><TextbausteinHinweis />                                         |
| `emailMismatch`       | string   | Error message output when the old email address was not transmitted correctly. <br /><br /><TextbausteinHinweis />                   |
| `missingPassword`     | string   | Error message output when no password was supplied. <br /><br /><TextbausteinHinweis />                                              |
| `passwordMismatch`    | string   | Error message output when the password and password confirmation do not match. <br /><br /><TextbausteinHinweis />                   |
| `missingPasswordAuth` | string   | Error message output when the current password is required as confirmation but not provided. <br /><br /><TextbausteinHinweis />     |
| `failedPasswordAuth`  | string   | Error message output when the entered current password is incorrect. <br /><br /><TextbausteinHinweis />                             |
| `passwordCheckFailed` | string   | Error message output when the password does not meet the minimum requirements. <br /><br /><TextbausteinHinweis />                   |