Authentification
Fonctionnement
L'authentification se fait par un jeton d'accès (access token) qui est à récupérer dans la réponse de la demande d'authentification. Nous utilisons le protocole OAuth2 pour l'authentification.
Il faudra pour cela récupérer un jeton d'accès (access token) en utilisant le flux d'authentification par mot de passe avec le compte de service (service account) de l'API que Covage vous fournira.
Authentification
Récupération du jeton d'accès
Récupération du jeton d'accès (access token) pour l'API Covage.
POST {{keycloak-url}}/auth/realms/covage/protocol/openid-connect/token
En-tête
Nom | Type | Description |
---|---|---|
Content-Type | string | Type de contenu de la requête (application/x-www-form-urlencoded) |
Paramètres
Nom | Type | Description | Obligatoire |
---|---|---|---|
grant_type | string | Type de flux d'authentification (password) | Oui |
client_id | string | Identifiant du client (api-client) | Oui |
username | string | Nom d'utilisateur du compte de service | Oui |
password | string | Mot de passe du compte de service | Oui |
Le username et le mot de passe sont fournis par Covage.
Le client_id est toujours api-client
pour ce flux d'authentification.
Le grant_type est toujours password
pour ce flux d'authentification.
Réponse
Nom | Type | Description |
---|---|---|
access_token | string | Jeton d'accès (access token) à utiliser dans les requêtes suivantes pour s'authentifier auprès de l'API |
expires_in | number | Durée de vie du jeton d'accès (en secondes) |
token_type | string | Type de jeton (Bearer) |
refresh_token | string | Jeton de rafraîchissement (refresh token) à utiliser pour récupérer un nouveau jeton d'accès (access token) |
refresh_expires_in | number | Durée de vie du jeton de rafraîchissement (en secondes) |
scope | string | Portée du jeton (scope) |
session_state | string | État de la session |