actions - Sign-in & registration

Actions around sign-in and registration in the shop: error texts and email templates for login, account unlocking as well as password reset.

This page documents all actions that relate to the sign-in and registration process in the online shop. Here all messages and email templates are documented that are displayed or sent when signing in, unlocking an account or resetting a password.

---

**Fehlertexte sind schreibgeschützt.** Die Fehlercode-Felder auf dieser Seite enthalten den Namen eines Textbausteins (ws.error.<configId>.<errorCode>), nicht den Fehlertext. Gepflegt wird der Text ausschließlich im Textbaustein-Dienst des Admin-Interface – Änderungen an der Konfiguration werden beim Speichern abgewiesen, auch über die [REST API](/schnittstellen/admin-interface-api/api-referenz-konfiguration). E-Mail-Vorlagen sind nicht betroffen.

Overview of actions

The actions listed here have been 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.

Excerpt of the basic actions structure

{
  "actions": {
    "acceptInvitation": {...},
    "checkPasswordStrength": {...},
    "login": {...},
    "unlockLogin": {...},
    "passwordForgotten": {...},
    "resetPassword": {...}
  }
}

Action overview

Action	Description
acceptInvitation	Defines the error messages 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 output during the sign-in process for a customer account.
unlockLogin	Defines the error messages output when lifting a login lock.
passwordForgotten	Defines the error messages output during the “password forgotten” process as well as the email that is sent.
resetPassword	Defines the error messages 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

{
  "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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
actionNotAllowed	string	Error message output when the double-opt-in token is invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

---

actions.checkPasswordStrength - Password strength / password security

The checkPasswordStrength action controls whether the shop system checks the strength of a password on the server side during actions such as registration or password change (for example based on the minimum length or complexity).

Example configuration

{
  "active": true
}

Parameter overview

Parameter	Type	Description
active	bool	Enables or disables the server-side check of the password strength. Default: true

---

actions.login - Sign-in

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

Example configuration

{
  "errorCodes": {
    "missingId": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "loginBlocked": "<Textbaustein>",
    "invalidCredentials": "<Textbaustein>",
    "ipAddressBlocked": "<Textbaustein>",
    "duplicatePendingReview": "<Textbaustein>",
    "passwordNotSet": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
errorCodes	object	Configures the error codes used for problems during the action.
missingId	string	Error message output when no login ID (for example email address) was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
missingPassword	string	Error message output when no password was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
emailCheckFailed	string	Error message output when the supplied email address is considered invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
loginBlocked	string	Error message output when the user account is temporarily locked. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
invalidCredentials	string	Error message output when the combination of email address and password is incorrect. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
ipAddressBlocked	string	Error message output when the current IP address is blocked (blacklist). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
duplicatePendingReview	string	Error message output when a sign-in is not possible because the account is still undergoing the duplicate check (see accounts.account → duplicate). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
passwordNotSet	string	Error message output when no password has been set yet for the employee account (only with employee accounts enabled). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

---

actions.unlockLogin - Unlock sign-in

With the unlockLogin action, you can define error messages that are output when lifting a login lock for a customer account.

Example configuration

{
  "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 unlock is not allowed (for example invalid link or missing permission). Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

---

actions.passwordForgotten - Password forgotten

With the passwordForgotten action, you define the error messages that are shown during the “password forgotten” process.

Example configuration

{
  "email": {
    "template": "password_forgotten.htm",
    "subject": "Passwort zurücksetzen",
    "fromAddress": "[e-mail]",
    "fromName": "Mein Onlineshop"
  },
  "errorCodes": {
    "missingEmail": "<Textbaustein>",
    "emailCheckFailed": "<Textbaustein>",
    "passwordRecoveryFailed": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
email	object	Configures the email that is sent when resetting the password. Subject, sender and template are controlled via the general email parameters, see here: Email settings
errorCodes	object	Configures the error codes used for problems during the action.
missingEmail	string	Error message output when no email address was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
emailCheckFailed	string	Error message output when the supplied email address is considered invalid. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
passwordRecoveryFailed	string	Error message output when the password reset fails. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.

---

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 performed.

The new password must differ from the previous password. After a successful change, the shop resets the account’s stored auto-login data and ends existing sessions. The link from the password reset email can only be used once.

Example configuration

{
  "autoLogout": true,
  "checkOldPassword": true,
  "checkLoginID": false,
  "errorCodes": {
    "notLoggedIn": "<Textbaustein>",
    "missingEmail": "<Textbaustein>",
    "emailMismatch": "<Textbaustein>",
    "missingPassword": "<Textbaustein>",
    "passwordMismatch": "<Textbaustein>",
    "missingPasswordAuth": "<Textbaustein>",
    "failedPasswordAuth": "<Textbaustein>",
    "passwordCheckFailed": "<Textbaustein>",
    "samePassword": "<Textbaustein>"
  }
}

Parameter overview

Parameter	Type	Description
autoLogout	bool	Sets whether the customer is automatically signed out after a successful password change. Does not apply if the change is made via an opt-in token. Default: true
checkOldPassword	bool	Indicates whether the previous password (passwordAuth) should additionally be requested and checked when changing the password. Does not apply if the change is made via an opt-in token. Default: true
checkLoginID	bool	If true, it is additionally checked whether the login ID/email supplied in the email parameter matches the account. 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. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
missingEmail	string	Error message output when no email address was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
emailMismatch	string	Error message output when the supplied email address does not belong to the account. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
missingPassword	string	Error message output when no password was supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
passwordMismatch	string	Error message output when the password and password confirmation do not match. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
missingPasswordAuth	string	Error message output when the current password is required as confirmation but was not supplied. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
failedPasswordAuth	string	Error message output when the entered current password is not correct. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
passwordCheckFailed	string	Error message output when the password does not meet the minimum requirements. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.
samePassword	string	Error message output when the new password matches the previous password. Dieser Text wird über einen Textbaustein realisiert. Alles zu Textbausteinen in Konfigurationen finden Sie hier.