[JWT] Start auth by email

Startet die Authentifizierung über die E-Mail-Adresse des Benutzers und sendet einen Bestätigungscode an ebendiese E-Mail-Adresse. Die Lebensdauer des Codes beträgt 3 Minuten.

Dieser Aufruf wird nur in Verbindung mit dem Aufruf Authentifizierung über E-Mail-Adresse abschließen verwendet.

So sieht der Ablauf aus:

Die Anwendung öffnet eine Authentifizierungsmaske, darin kann der Benutzer seine E-Mail-Adresse eingeben.
Der Benutzer gibt seine E-Mail-Adresse ein.
Die Anwendung sendet diese Anfrage an den Xsolla-Login-Server: a) Wenn der Parameter send_link auf true gestellt ist, sollten Sie im Anschluss an diese Anfrage die Anfrage Bestätigungscode abrufen senden, damit die E-Mail den Bestätigungscode und den Link enthält. b) Wenn der Parameter send_link auf false gestellt ist oder nicht übermittelt wird, enthält die E-Mail nur den Bestätigungscode.
Der Xsolla-Login-Server sendet die E-Mail und gibt die ID des Bestätigungscodes zurück.
Die Anwendung zeigt ein Feld an, in das der Benutzer den Bestätigungscode eingeben kann.
Der Benutzer gibt den erhaltenen Bestätigungscode ein oder klickt auf den Link.
Die Anwendung sendet die Anfrage Authentifizierung über E-Mail-Adresse abschließen samt der erhaltenen ID an den Xsolla-Login-Server.
Daraufhin wird der Benutzer als autorisiert betrachtet.

Request

query Parameters

projectId required	string <uuid> Login-Projekt-ID aus dem Kundenportal.
login_url	string URL to redirect the user to after account confirmation, successful authentication, two-factor authentication configuration, or password reset confirmation. Must be identical to the Callback URL specified in the URL block of Publisher Account. For the scenario of a login error, the value should be identical to the the Error callback URL specified in the URL block of Publisher Account. To find the settings, go to Login > your Login project and select the Callback URLs section in the upper block. Required if there are several Callback URLs.
payload	string Your custom data. The value of the parameter will be returned in the `payload` claim of the user JWT. Recommended maximum length less than 500 characters. Note, that this parameter is only available if you use a custom user data storage.
with_logout	string Default: "0" Zeigt an, ob die vorhandenen Benutzer-JWT-Werte deaktiviert und stattdessen der durch diesen Aufruf generierte Wert aktiviert werden sollen. Folgende Werte sind möglich: `1`, um die vorhandenen Werte zu deaktivieren und einen neuen Wert zu aktivieren, `0`, damit die vorhandenen Werte aktiviert bleiben.

Request Body schema: application/json

email required	string [ 1 .. 255 ] characters E-Mail-Adresse des Benutzers.
link_url	string <uri> URL zur Weiterleitung des Benutzers auf die Statusauthentifizierungsseite. Erforderlich, wenn der Parameter `send_link` auf `true` gesetzt ist.
send_link	boolean Zeigt an, ob ein Link mit dem Bestätigungscode in der E-Mail enthalten ist oder nicht. Der Link kann anstelle des Bestätigungscodes zum Anmelden verwendet werden. Wenn der Parameter den Wert `true` hat, ist der Link in der E-Mail enthalten.

Responses

200

400

Bad Request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples

application/json

{"email": "string",
"link_url": "http://example.com",
"send_link": true
}

Response samples

application/json

{"operation_id": "string"
}