Xsolla-logo

Générer un JWT

post/oauth2/token

Utilisez cet appel :

  • Pour obtenir un JWT utilisateur.
  • Pour actualiser le JWT lorsqu'il expire. Ne fonctionne que si scope=offline est passé dans l'appel d'enregistrement ou d'authentification.
  • Pour obtenir un JWT de serveur . La participation de l'utilisateur n'est pas nécessaire.
  • Pour échanger le JWT utilisateur contre un nouveau JWT de portée différente.

L'utilisation de cet appel dépend de la valeur du paramètre grant_type.

Request
Request Body schema: application/x-www-form-urlencoded
grant_type
required
string

Type d'obtention du JWT. Valeurs possibles :

  • authorization_code : pour échanger le code obtenu lors de l'appel d'authentification par JWT. La valeur du paramètre code doit être spécifiée.
  • refresh_token : pour obtenir le JWT actualisé lorsque le précédent a expiré. La valeur du paramètre refresh_token doit être spécifiée.
  • client_credentials : pour obtenir le JWT du serveur. Les valeurs des paramètres client_id et client_secret doivent être spécifiées.
  • urn:ietf:params:oauth:grant-type:token_exchange : pour échanger le JWT utilisateur existant contre un JWT de portée différente.
client_id
required
string

Votre ID d'application. La valeur de ce paramètre dépend de la valeur du paramètre grant_type :

Notez que les valeurs des paramètres client_secret et client_id doivent appartenir au même client.

refresh_token
string

Valeur de ce paramètre reçue dans la réponse à la dernière requête de cet appel avec les valeurs authorization_code ou refresh_token dans le paramètre grant_type. Requise si grant_type=refresh_token.

client_secret
string

Votre clé secrète. La valeur de ce paramètre dépend de la valeur du paramètre grant_type :

  • Si c'est authorization_code, créez un client OAuth 2.0 et utilisez sa clé secrète. Requise si vous avez créé un client OAuth 2.0 avec un type d'authentification confidentiel.
  • Si c'est client_credentials, contactez votre responsable de la réussite client pour créer un client OAuth 2.0 de serveur et obtenir sa clé secrète. Requise pour ce type de client.

Notez que les valeurs des paramètres client_secret et client_id doivent appartenir au même client.

redirect_uri
string
code
string

Code d'authentification échangé contre un JWT. Requis si grant_type=authorization_code.

code_verifier
string

Le vérificateur de code pour la requête PKCE, que l'application a généré à l'origine avant la requête d'autorisation.

audience
string

Liste des domaines pour lesquels le jeton peut être appliqué

scope
string

Liste de chaînes de caractères délimités par des espaces et sensibles à la casse, comme cela est défini dans la section 3.3 de [RFC6749]. Elle permet au client de spécifier la portée souhaitée du jeton de sécurité demandé dans le contexte du service ou de la ressource où le jeton sera utilisé. Les valeurs et la sémantique associée de la portée sont spécifiques au service et doivent être décrites dans la documentation du service concerné

subject_token
string

Jeton de sécurité représentant l'identité de la partie au nom de laquelle la requête est effectuée. En général, le sujet de ce jeton correspondra au sujet du jeton de sécurité délivré en réponse à la requête.

subject_token_type
string

Jeton de sécurité représentant l'identité de la partie au nom de laquelle la requête est effectuée. En général, le sujet de ce jeton correspondra au sujet du jeton de sécurité délivré en réponse à la requête.

Value: "access_token"
actor_token
string

Jeton de sécurité représentant l'identité de la partie qui agit. En général, il s'agit de la partie autorisée à utiliser le jeton de sécurité demandé et à agir au nom du sujet.

actor_token_type
string

Identificateur, te que décrit dans la Section 3, qui indique le type de jeton de sécurité dans le paramètre actor_token. Il est OBLIGATOIRE lorsque le paramètre actor_token est présent dans la requête, mais NE DOIT PAS être inclus dans les autres cas.

Value: "server_token"
Responses
200

OK

400

Bad Request

404

Not Found

418

I’m a teapot

422

Unprocessable Entity

429

Too Many Requests

Request samples
application/x-www-form-urlencoded
refresh_token=string&grant_type=string&client_secret=string&client_id=string&redirect_uri=string&code=string&code_verifier=string&audience=string&scope=string&subject_token=string&subject_token_type=access_token&actor_token=string&actor_token_type=server_token
Response samples
application/json
{
  • "access_token": "2YotnFZFEjr1zCsicMWpAA",
  • "expires_in": 3600,
  • "refresh_token": "tGzv3JOkF0XG5Qx2TlKWIA",
  • "scope": "email user_profile",
  • "token_type": "bearer"
}