Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 96.1
edited by Aurelie Bertrand
on 2025/04/29 17:20
Change comment: There is no comment for this version
To version 99.1
edited by Aurelie Bertrand
on 2025/05/02 14:47
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -136,10 +136,9 @@
136 136  
137 137  == S'authentifier via ApiKeyAuth ==
138 138  
139 -
140 140  Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
141 141  
142 -=== Créer une clé API ===
141 +=== Créer une clé API{{id name="API"/}} ===
143 143  
144 144  Nous allons créer ici une clé API :
145 145  
... ... @@ -164,10 +164,12 @@
164 164  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
165 165  [[image:1745928288556-250.png||alt="Réponse serveur"]]
166 166  1. Copiez la clé API.
166 +❗La clé affichée n'est affichée qu'une seule fois et ne peut être récupérée autrement car elle est hashée (cryptée de façon irréversible) lors du stockage sur le serveur pour des raisons de sécurité.(((
167 +Si une clé est perdue ou inutile, elle doit être invalidée et une autre clé doit être créée si nécessaire.
168 +)))
167 167  
168 168  (% class="wikigeneratedid" %)
169 169  La clé API est stockée côté serveur dans un fichier csv //apikeys.csv, //situé par défaut dans le répertoire //appdata/EnterpriseServer/ddenterpriseapi/config. //Vous pouvez modifier le répertoire, ou spécifier les répertoires dans le cas de plusieurs domaines, dans le fichier //digdash.properties// en les ajoutant sous la forme suivante //: ddenterprise.api_keys_path=/chemin/vers/fichier.csv.//
170 -La clé est hashée et ne peut donc être récupérée.
171 171  
172 172  === S'authentifier ===
173 173  
... ... @@ -185,7 +185,7 @@
185 185  Les ressources disponibles sont classées par type :
186 186  
187 187  * **Authentification **: pour la création des jetons de sécurité (JWT)
188 -* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autosations des rôles, etc.
189 +* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autorisations des rôles, etc.
189 189  * **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
190 190  * **System** : pour les informations système, service d'audit et ordonnanceur.
191 191  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
... ... @@ -207,7 +207,7 @@
207 207  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
208 208  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
209 209  
210 -== Envoi de requêtes ==
211 +== Envoi de requêtes{{id name="envoi"/}} ==
211 211  
212 212  (% class="box warningmessage" %)
213 213  (((
... ... @@ -239,7 +239,7 @@
239 239  |(% style="width:173px" %)resolveProfiles|(% style="width:1214px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
240 240  Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seront affichés et non pas les rôles propres à l'utilisateur.
241 241  |(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Session management**
242 -|(% style="width:173px" %)users|(% style="width:1214px" %)Vous pouvez spécifier des utilisateurs pour la requête : cliquez sur le bouton **Add string item** et entrez le nom d'un utilisateur. Répétez l'opération si besoin avec les autres utilisateurs. 
243 +|(% style="width:173px" %)users|(% style="width:1214px" %)Vous pouvez spécifier des utilisateurs pour la requête : cliquez sur le bouton **Add string item** et entrez le nom d'un utilisateur. Répétez l'opération si besoin avec les autres utilisateurs.         
243 243  |(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Connection management**
244 244  |(% style="width:173px" %)itemRole|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données resteintes aux rôles spécifiés ici.
245 245  |(% style="width:173px" %)nameFilter|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données dont le nom contient la chaîne texte spécifiée ici.
... ... @@ -276,7 +276,7 @@
276 276  1. Vous pouvez tout d'abord récupérer la liste des clés API ave leur identifiant en utilisant **GET /api/v1/auth/apikeys**. Vous obtenez la liste sous la forme suivante :
277 277  [[image:1745932166616-318.png||alt="Liste clés API"]]
278 278  
279 -1. Utilisez ensuite **DELETE /api/v1/auth/apikeys **: entrez l'identifiant de la clé API à invalider ou, dans le cas de plusieurs clés, les identifiants séparés par des virgules.
280 +1. Envoyez une liste d'identifiants (en JSON ou XML selon le Content-Type comme expliqué dans la partie [[Envoi de requêtes>>doc:||anchor="envoi"]]) à "POST /api/v1/auth/apikeys/delete" pour invalider une ou plusieurs clés
280 280  
281 281  Pour invalider toutes les clés API, supprimez toutes les clés comme ci-dessus ou supprimer le fichier csv //apikeys.csv //contenant les clés avec le serveur éteint.
282 282