OAuth 2.0-Autorisierung

OAuth 2.0-AutorisierungClient-side

get/oauth2/auth

Überprüft, ob eine gültige SSO-Sitzung vorliegt. Leitet mithilfe eines Autorisierungscodes zu der im Parameter redirect_url übermittelten URL weiter.

Request

query Parameters

response_type required	string Wird auf Code gesetzt, was darauf hinweist, dass die Anwendung im Erfolgsfall einen Autorisierungscode erwartet. Value: "code"
client_id required	integer ID Ihrer Anwendung. Diese erhalten Sie, nachdem Sie einen OAuth 2.0 Client erstellt haben.
redirect_uri required	string Diese URL muss mit einer der URLs übereinstimmen, die der Entwickler beim Erstellen der Anwendung registriert hat, andernfalls sollte der Autorisierungsserver die Anfrage zurückweisen. Wenden Sie sich an Ihren Customer Success Manager, um diesen Parameter einzurichten.
scope required	string Die Anfrage kann einen oder mehrere Werte für den Geltungsbereich enthalten und so auf von der Anwendung angeforderte zusätzliche Zugriffsrechte hinweisen. Der Autorisierungsserver muss dem Benutzer die angeforderten Geltungsbereiche anzeigen.
state required	string Anhand des Zustandsparameters kann die Anwendung anforderungsspezifische Daten speichern und/oder CSRF-Angriffe abwehren. Der Autorisierungsserver muss den unveränderten Zustandswert an die Anwendung zurückgeben. Dies ist der empfohlene Parameter.
audience required	string Der Audience-Parameter kann mehrere Strings enthalten, die durch ein URL-codiertes Leerzeichen (+ oder %20) getrennt sind. Die Audience-Werte selbst müssen ebenfalls URL-codiert sein.
popup	boolean Default: false Wird "true" übermittelt, leitet die Methode zuerst zum Widget und dann zum Rückruf des Partners weiter. Wird "false" übermittelt, leitet die Methode direkt zum Rückruf des Partners weiter.
code_challenge	string Aus dem `code_verifier` (https://datatracker.ietf.org/doc/html/rfc7636#section-4-2) generierte Herausforderung.
code_challenge_method	string Methode für das Generieren der Herausforderung. Derzeit können Sie nur die Methode "S256" verwenden, um `code_challenge` zu generieren. Value: "S256"
widget_only	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.
enable_post_message_login	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.
disable_socials	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.
fail_auth_url	string If passed then method will redirect on this URL in case of a missing session for authentication and obtaining new session.
disable_passwordless_email	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.
disable_passwordless_phone	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.
is_xsolla_link	boolean Dienstparameter für den Pop-up-Flow. Hat keinen Einfluss auf das API-Verhalten.

Responses

302

Redirection

400

Bad Request

404

Not Found

418

I’m a teapot

422

Unprocessable Entity

429

Too Many Requests

Request samples

curl --request GET \
  --url 'https://login.xsolla.com/api/oauth2/auth?response_type=SOME_STRING_VALUE&client_id=SOME_INTEGER_VALUE&redirect_uri=SOME_STRING_VALUE&scope=SOME_STRING_VALUE&state=SOME_STRING_VALUE&audience=SOME_STRING_VALUE&popup=false&code_challenge=SOME_STRING_VALUE&code_challenge_method=SOME_STRING_VALUE&widget_only=SOME_BOOLEAN_VALUE&enable_post_message_login=SOME_BOOLEAN_VALUE&disable_socials=SOME_BOOLEAN_VALUE&fail_auth_url=SOME_STRING_VALUE&disable_passwordless_email=SOME_BOOLEAN_VALUE&disable_passwordless_phone=SOME_BOOLEAN_VALUE&is_xsolla_link=SOME_BOOLEAN_VALUE' \
  --header 'accept: application/x-www-form-urlencoded'

Response samples

{"error": {"code": "003-061",
"description": "Object not found.",
"details": { }
}
}