Skip to main content
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.

​
Excerpt of the basic actions structure

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

​
Action overview

ActionDescription
acceptInvitationDefines the error messages that are output when accepting an invitation to a B2B account.
checkPasswordStrengthControls whether the shop checks the strength of a password.
loginDefines the error messages that are output during the sign-in process to a customer account.
unlockLoginDefines the error messages that are output when lifting a login block.
passwordForgottenDefines the error messages that are output during the “forgot password” flow, as well as the email that is sent.
resetPasswordDefines 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

{
  "errorCodes": {
    "invalidAccountId": "<Textbaustein>",
    "actionNotAllowed": "<Textbaustein>"
  }
}

​
Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
invalidAccountIdstringError message output when the double opt-in token cannot be assigned to a customer account.

actionNotAllowedstringError message output when the double opt-in token is invalid.

​
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

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
invalidAccountIdstringError message output when the double opt-in token cannot be assigned to a customer account.

actionNotAllowedstringError message output when the double opt-in token is invalid.

​
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

{
  "active": true
}

​
Parameter overview

ParameterTypeDescription
activeboolEnables or disables the server-side password strength check.
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

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

​
Parameter overview

ParameterTypeDescription
errorCodesarrayConfigures the error codes used for problems during the action.
missingIdstringError message output when no login ID (e.g. email address) was supplied.

missingPasswordstringError message output when no password was supplied.

emailCheckFailedstringError message output when the provided email address is considered invalid.

loginBlockedstringError message output when the user account is temporarily blocked.

invalidCredentialsstringError message output when the combination of email address and password is incorrect.

ipAddressBlockedstringError message output when the current IP address is blocked (blacklist).

​
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

{
  "errorCodes": {
    "unauthorized": "<Textbaustein>"
  }
}

​
Parameter overview

ParameterTypeDescription
errorCodesobjectConfigures the error codes used for problems during the action.
unauthorizedstringError message output when the unblocking is not permitted (e.g. invalid link or missing authorisation).

​
actions.passwordForgotten - Forgot password

The passwordForgotten action defines the error messages that are shown during the “forgot password” flow.

​
Example configuration

{
  "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

ParameterTypeDescription
emailobjectConfigures the email sent when resetting the password. Subject, sender and template are controlled via the general email parameters, see here: Email settings
errorCodesobjectConfigures the error codes used for problems during the action.
missingEmailstringError message output when no email address was supplied.

emailCheckFailedstringError message output when the provided email address is considered invalid.

passwordRecoveryFailedstringError message output when the password reset fails.

​
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

{
  "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

ParameterTypeDescription
autoLogoutboolDetermines whether the customer is automatically logged out after a successful password change.
Default: true
checkOldPasswordboolIndicates whether the previous password is additionally requested and verified when changing the password.
Default: true
checkLoginIDboolIf true, an additional check is performed to verify that the supplied login ID/email matches the account.
Default: false
errorCodesobjectConfigures the error codes used for problems during the action.
notLoggedInstringError message output when the user is not signed in.

missingEmailstringError message output when no email address was supplied.

emailMismatchstringError message output when the old email address was not transmitted correctly.

missingPasswordstringError message output when no password was supplied.

passwordMismatchstringError message output when the password and password confirmation do not match.

missingPasswordAuthstringError message output when the current password is required as confirmation but not provided.

failedPasswordAuthstringError message output when the entered current password is incorrect.

passwordCheckFailedstringError message output when the password does not meet the minimum requirements.