Lancer l'authentification par adresse e-mail

post/oauth2/login/email/request

Lance l'authentification par adresse e-mail utilisateur et envoie un code de confirmation par e-mail à l'utilisateur. La durée de vie du code est de 3 minutes.

Cet appel est utilisé uniquement avec l'appel Compléter l'authentification par adresse e-mail.

Flux d'utilisation de cet appel :

L'application ouvre un formulaire d'authentification pour que l'utilisateur puisse saisir son adresse e-mail.
L'utilisateur saisit son adresse e-mail.
L'application envoie cette requête au serveur Xsolla Login : a. Si la valeur du paramètre send_link est true, après cette requête, vous devez envoyer la requête Lire un code de confirmation pour que l'e-mail contienne le code de confirmation et le lien ; b. Si la valeur du paramètre send_link est false ou n'est pas passée, l'e-mail contiendra uniquement le code de confirmation.
Le serveur Xsolla Login envoie l'e-mail et renvoie l'ID du code de confirmation.
L'application affiche un champ pour que l'utilisateur puisse saisir le code de confirmation.
L'utilisateur saisit le code de confirmation reçu ou suit le lien.
L'application envoie la requête Compléter l'authentification par adresse e-mail au serveur Xsolla Login avec l'ID reçu.
L'utilisateur est considéré comme autorisé.

Request

query Parameters

response_type required	string Type de subvention utilisé dans votre projet avec protocole OAuth 2.0 activé. Passez la valeur `code` pour obtenir le code d'authentification utilisateur dans la réponse. Le code reçu doit être échangé contre un JWT en utilisant l'appel Générer un JWT pour finaliser l'authentification de l'utilisateur.
client_id required	integer Votre ID d'application. Vous l'obtiendrez après avoir créé un client OAuth 2.0.
state required	string Valeur utilisée pour une vérification supplémentaire de l'utilisateur. Souvent utilisée pour atténuer les attaques CSRF. La valeur est renvoyée dans la réponse. Elle doit comporter plus de 8 symboles.
scope	string La portée est un mécanisme dans OAuth 2.0 qui permet de limiter l'accès d'une application au compte d'un utilisateur. Valeurs possibles : `offline` : pour utiliser `refresh_token` dans l'appel Générer un JWT pour actualiser le JWT lorsqu'il est expiré. `playfab` : pour écrire SessionTicket dans la revendication `session_ticket` du JWT si le stockage des données utilisateur est PlayFab. Si vous utilisez vos propres valeurs du paramètre `scope` qui ne sont pas mentionnées ci-dessus, définissez-les lors de l'appel. Le serveur Xsolla Login ne les traitera pas directement, mais les inclura dans le JWT renvoyé.
redirect_uri	string URL de redirection utilisateur après une confirmation du compte, une authentification réussie ou une confirmation de la réinitialisation du mot de passe. Pour configurer ce paramètre, contactez votre responsable de la réussite client ou envoyez un e-mail à csm@xsolla.com. Remarque Ce paramètre est requis si vous avez plus d'un URI de redirection dans les paramètres de votre projet.

Request Body schema: application/json

email required	string [ 1 .. 255 ] characters Adresse e-mail de l'utilisateur.
link_url	string <uri> URL de redirection de l'utilisateur vers la page d'état de l'authentification. Requis si la valeur du paramètre `send_link` est `true`.
send_link	boolean Indique si un lien est envoyé avec le code de confirmation dans l'e-mail ou non. Le lien peut être utilisé à la place du code de confirmation pour se connecter. Si la valeur du paramètre est `true`, le lien est envoyé dans l'e-mail.

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