[OAuth2.0] 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

response_type required	string Der in Ihrem Projekt verwendete Grant-Typ, für den das OAuth 2.0-Protokoll aktiviert ist. Muss `code` sein, um den Benutzerauthentifizierungscode in der Antwort zu erhalten. Der empfangene Code muss über den Aufruf JWT generieren gegen einen JWT getauscht werden, um die Benutzerauthentifizierung abzuschließen.
client_id required	integer ID Ihrer Anwendung. Diese erhalten Sie, nachdem Sie einen OAuth 2.0 Client erstellt haben.
state required	string Wert, der für eine zusätzliche Benutzerprüfung verwendet wird. Wird meist dazu verwendet, CSRF-Angriffe abzuschwächen. Der Wert wird in der Antwort zurückgegeben. Er muss mindestens 9 Zeichen umfassen.
scope	string Scope (deutsch: Geltungsbereich) ist ein Mechanismus in OAuth 2.0, um den Zugriff einer Anwendung auf das Konto eines Benutzers zu beschränken. Möglich sind: `offline`, um mit dem `refresh_token` aus dem Aufruf JWT generieren den JWT bei dessen drohendem Verfall zu aktualisieren. `playfab`, um SessionTicket in den `session_ticket`-Claim des JWT zu schreiben, sofern Sie Benutzerdaten bei PlayFab speichern. Sie können bei diesem Aufruf für den `scope`-Parameter eigene, nicht obenerwähnte Werte festlegen. Der Xsolla-Login-Server verarbeitet diese Werte nicht, sondern gibt sie im empfangenen JWT zurück.
redirect_uri	string URL, zu der der Benutzer nach der Kontobestätigung, der erfolgreichen Authentifizierung oder dem Zurücksetzen des Passworts weitergeleitet wird. Wenden Sie sich an Ihren Customer Success Manager oder senden Sie eine E-Mail an csm@xsolla.com, um diesen Parameter einzurichten. Hinweis: Der Parameter ist erforderlich, wenn Sie mehr als eine URI für die Weiterleitung in Ihren Projekteinstellungen haben.

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