Xsolla-logo

Authentifizierung über E-Mail-Adresse starten

post/login/email/request

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:

  1. Die Anwendung öffnet eine Authentifizierungsmaske, darin kann der Benutzer seine E-Mail-Adresse eingeben.
  2. Der Benutzer gibt seine E-Mail-Adresse ein.
  3. 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.
  4. Der Xsolla-Login-Server sendet die E-Mail und gibt die ID des Bestätigungscodes zurück.
  5. Die Anwendung zeigt ein Feld an, in das der Benutzer den Bestätigungscode eingeben kann.
  6. Der Benutzer gibt den erhaltenen Bestätigungscode ein oder klickt auf den Link.
  7. Die Anwendung sendet die Anfrage Authentifizierung über E-Mail-Adresse abschließen samt der erhaltenen ID an den Xsolla-Login-Server.
  8. Daraufhin wird der Benutzer als autorisiert betrachtet.
Request
query Parameters
projectId
required
string <uuid>

Login-Projekt-ID aus dem Kundenportal.

login_url
string

URL, zu der der Benutzer nach der Kontobestätigung, der erfolgreichen Authentifizierung, der Konfiguration der Zwei-Faktor-Authentifizierung oder dem Zurücksetzen des Passworts weitergeleitet wird. Muss mit der im Kundenportal im Block URL angegebenen Rückruf-URL übereinstimmen. Navigieren Sie dafür zu Login > Ihr Login-Projekt, die URL finden Sie auf der Navigationsseite, wenn Sie im obersten Block auf Rückruf-URLs klicken. Erforderlich, wenn mehrere Rückruf-URLs vorhanden sind.

payload
string

Ihre benutzerdefinierten Daten. Der Wert des Parameters wird im payload-Claim des Benutzer-JWT zurückgegeben.

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

OK

400

Bad Request

404

Not Found

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/json
{}
Response samples
application/json
{
  • "operation_id": "string"
}