Autorisation OAuth 2.0

Autorisation OAuth 2.0Client-side

get/oauth2/auth

Vérifie la présence d'une session SSO valide. Redirige vers l'URL passée dans le paramètre redirect_url avec un code d'autorisation.

Request

query Parameters

response_type required	string Prendra la valeur code, indiquant que l'application s'attend à recevoir un code d'autorisation en cas de succès. Value: "code"
client_id required	integer Votre ID d'application. Vous l'obtiendrez après avoir créé un client OAuth 2.0.
redirect_uri required	string Cette URL doit correspondre à l'une des URL enregistrées par le développeur lors de la création de l'application, et le serveur d'autorisation doit rejeter la requête si elle ne correspond pas. Pour configurer ce paramètre, contactez votre responsable de la réussite client.
scope required	string La requête peut comporter une ou plusieurs valeurs de portée, indiquant l'accès supplémentaire demandé par l'application. Le serveur d'autorisation devra afficher les portées demandées à l'utilisateur.
state required	string Le paramètre state est utilisé par l'application pour stocker des données spécifiques à la requête et/ou prévenir les attaques CSRF. Le serveur d'autorisation doit renvoyer à l'application la valeur de state inchangée. Il est recommandé d'utiliser ce paramètre.
audience required	string Le paramètre audience peut contenir plusieurs chaînes séparées par un espace codé en url (+ ou %20). Les valeurs d'audience elles-mêmes doivent également être codées en url.
popup	boolean Default: false Si la valeur true est passée, la méthode redirige d'abord vers le widget, puis vers l'URL de retour du partenaire. Si false, la méthode redirige directement vers le l'URL de retour du partenaire.
code_challenge	string Challenge généré par un `code_verifier` (https://datatracker.ietf.org/doc/html/rfc7636#section-4-2).
code_challenge_method	string Méthode utilisée pour générer le challenge. Pour l'instant, vous ne pouvez utiliser que la méthode `S256` pour générer un `code_challenge`. Value: "S256"
widget_only	boolean Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.
enable_post_message_login	boolean Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.
disable_socials	boolean Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.
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 Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.
disable_passwordless_phone	boolean Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.
is_xsolla_link	boolean Paramètre de service pour le flux pop up. N'affecte pas le comportement de l'API.

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