Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 8.1
edited by Aurelie Bertrand
on 2024/08/29 11:46
Change comment: There is no comment for this version
To version 15.2
edited by Aurelie Bertrand
on 2024/08/29 15:10
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,4 +1,4 @@
1 -= Ouvrir Swagger UI =
1 += Accéder à Swagger UI =
2 2  
3 3  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 4  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
... ... @@ -22,7 +22,7 @@
22 22  Deux méthodes d'autorisation sont actuellement disponibles :
23 23  
24 24  * (((
25 -**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
25 +**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 26  )))
27 27  * (((
28 28  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -60,12 +60,47 @@
60 60  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61 61  1. Copiez le jeton JWT.
62 62  
63 +=== Signature du jeton de sécurité ===
64 +
65 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
66 +
67 +Pour des raisons de sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
68 +
69 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
70 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
71 +
72 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
73 +
74 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
75 +
76 +{{code language="shell"}}
77 +openssl -genrsa -out /path/to/privatekey.pem 2048
78 +{{/code}}
79 +
80 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
81 +
82 +{{code language="shell"}}
83 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
84 +{{/code}}
85 +
63 63  == Authentification via BearerAuth ==
64 64  
65 -== (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :(%%) ==
88 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
89 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
66 66  
67 67  1. Cliquez sur le bouton **Authorize**.
68 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
92 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
93 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
69 69  1. Cliquez sur **Authorize**.
70 70  
96 += API disponibles =
97 +
98 +Les API disponibles sont classées par type :
99 +
100 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
101 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
102 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
103 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
104 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
105 +
71 71