---
updatedAt: 2026-05-21T16:39:58.000Z
---
# Échange d'un jeton de support valide contre une session de navigation authentifiée
Ce point d'accès prend un jeton d'authentification dans l'en-tête, ou comme paramètre de requête "access_token". Toutefois, pour des raisons de sécurité, il est recommandé de transmettre le jeton en utilisant l'appel API POST.
Il utilise "scoped=true" comme paramètre de requête de manière facultative. Lorsque "scoped=true" est indiqué, le cookie créé est utilisé pour se connecter à l'application concernée. Si "scoped=true" n'est pas indiqué, le cookie créé est utilisé pour se connecter à une application non scopée.
Il utilise "redirect_url" comme paramètre de requête en option. Si "redirect_url" est indiqué, l'appel sera redirigé vers la redirection URL avec la session authentifiée.
# OpenAPI definition
```json
{
"openapi": "3.0.1",
"info": {
"version": "1.0.0",
"description": "Authentication",
"title": "Authentication"
},
"servers": [
{
"url": "https://{tenanturl}",
"variables": {
"tenanturl": {
"default": "{tenant_url}",
"description": "URL of your IBM Security Verify tenant"
}
}
}
],
"tags": [
{
"name": "Authentication Token Exchange"
}
],
"paths": {
"/v1.0/auth/session": {
"get": {
"tags": [
"Authentication Token Exchange"
],
"summary": "Échange d'un jeton de support valide contre une session de navigation authentifiée",
"description": "Ce point d'accès prend un jeton d'authentification dans l'en-tête, ou comme paramètre de requête \"access_token\". Toutefois, pour des raisons de sécurité, il est recommandé de transmettre le jeton en utilisant l'appel API POST.\n
Il utilise \"scoped=true\" comme paramètre de requête de manière facultative. Lorsque \"scoped=true\" est indiqué, le cookie créé est utilisé pour se connecter à l'application concernée. Si \"scoped=true\" n'est pas indiqué, le cookie créé est utilisé pour se connecter à une application non scopée.\n
Il utilise \"redirect_url\" comme paramètre de requête en option. Si \"redirect_url\" est indiqué, l'appel sera redirigé vers la redirection URL avec la session authentifiée.\n",
"operationId": "exchangeToken1",
"parameters": [
{
"name": "scoped",
"in": "query",
"description": "Si c'est le cas, il crée une session pour la connexion à l'application. Si false, il crée une session pour la connexion d'une application non couverte par l'application",
"schema": {
"type": "boolean"
}
},
{
"name": "access_token",
"in": "query",
"description": "Le jeton d'accès utilisé pour créer la session de navigation authentifiée. Utile pour les tests, mais il est recommandé de transmettre le jeton dans l'en-tête Authorization, car les paramètres de URL peuvent être interceptés.",
"schema": {
"type": "string"
}
},
{
"name": "redirect_url",
"in": "query",
"description": "Le site URL où la demande sera redirigée après la création de la session. L'adresse URL doit être codée URL, sinon la redirection authentifiée risque d'échouer. Une erreur est renvoyée si le URL n'est pas autorisé.
Un URL valide doit répondre à l'une des conditions suivantes:
- Commence par le nom du locataire, \" https://tenantname.com \"
- Est un chemin relatif, il commence par \"/\"
- Correspond à l'une des URL de la liste des URL autorisées dans l'API de gestion de l'échange de sessions",
"schema": {
"type": "string"
}
}
],
"responses": {
"201": {
"description": "Un jeton d'accès a été échangé avec succès contre un identifiant de session IBM Security Verify.",
"content": {}
},
"302": {
"description": "Renvoyé lorsque le paramètre \"redirect_url\" est passé. Après un échange de jeton réussi, le navigateur sera redirigé vers la redirect_url",
"content": {}
},
"400": {
"description": "Le système ne peut pas traiter la demande car aucun jeton d'accès n'a été trouvé dans la demande. Un jeton d'accès doit être présent dans l'en-tête HTTP 'Authorization' ou dans le paramètre de requête 'access_token'.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/BadRequest"
}
}
}
},
"401": {
"description": "La demande n'a pas fourni d'authentification ou l'authentification n'a pas abouti.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Unauthorized"
}
}
}
},
"403": {
"description": "Le jeton d'accès utilisé ne permet pas d'accéder à la ressource demandée.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/Forbidden"
}
}
}
},
"500": {
"description": "Une erreur inattendue s'est produite lors de l'acquisition des données utilisateur nécessaires.",
"content": {
"*/*": {
"schema": {
"$ref": "#/components/schemas/ServerError"
}
}
}
}
},
"x-publicAPI": "true",
"x-category": "Authentication"
}
}
},
"components": {
"schemas": {
"BadRequest": {
"required": [
"messageDescription",
"messageId"
],
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "L'identifiant de la clé de message",
"example": "CSIAH0643E"
},
"messageDescription": {
"type": "string",
"description": "Un message descriptif spécifique au local du demandeur",
"example": "The system cannot process the request because no access token was found in the request. An access token must be present in either the 'Authorization' HTTP header or in the query parameter 'access_token'."
}
}
},
"Unauthorized": {
"required": [
"messageDescription",
"messageId"
],
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "L'identifiant de la clé de message",
"example": "CSIAH0611E"
},
"messageDescription": {
"type": "string",
"description": "Un message descriptif spécifique au local du demandeur",
"example": "The access token included in the request is not valid."
}
}
},
"Forbidden": {
"required": [
"messageDescription",
"messageId"
],
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "L'identifiant de la clé de message",
"example": "CSIAK4300E"
},
"messageDescription": {
"type": "string",
"description": "Un message descriptif spécifique au local du demandeur",
"example": "The authenticated user is not permitted to perform the requested operation."
}
}
},
"ServerError": {
"required": [
"messageDescription",
"messageId"
],
"type": "object",
"properties": {
"messageId": {
"type": "string",
"description": "L'identifiant de la clé de message",
"example": "CSIAH0601E"
},
"messageDescription": {
"type": "string",
"description": "Un message descriptif spécifique au local du demandeur",
"example": "An internal error occurred in the Authentication Service"
}
}
}
}
},
"x-original-swagger-version": "2.0",
"x-explorer-enabled": false
}
```