Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 84.1
edited by Aurelie Bertrand
on 2025/04/29 14:46
Change comment: There is no comment for this version
To version 99.2
edited by Aurelie Bertrand
on 2025/05/15 16:29
Change comment: Le tag [Clé API] a été ajouté

Summary

Details

Page properties
Tags
... ... @@ -1,0 +1,1 @@
1 +API|Clé API
Content
... ... @@ -39,7 +39,7 @@
39 39  * (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Cliquez sur le bouton (%%)**Authorize**(% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%)
40 40  ➡ (% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)La fenêtre (%%)**Available authorizations** ((% style="color:#182027; font-family:Arial,sans-serif; font-size:10.5pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)Autorisations disponibles) s'affiche.
41 41  
42 -Deux méthodes d'autorisation sont actuellement disponibles :
42 +Trois méthodes d'autorisation sont disponibles :
43 43  
44 44  * (((
45 45  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
... ... @@ -74,7 +74,7 @@
74 74  
75 75  Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
76 76  
77 -=== Créer un jeton de sécurité ===
77 +=== Créer un jeton JWT{{id name="JWT"/}} ===
78 78  
79 79  Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
80 80  
... ... @@ -136,8 +136,10 @@
136 136  
137 137  == S'authentifier via ApiKeyAuth ==
138 138  
139 -=== Créer une clé API ===
139 +Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
140 140  
141 +=== Créer une clé API{{id name="API"/}} ===
142 +
141 141  Nous allons créer ici une clé API :
142 142  
143 143  1. Allez dans la section **Authentication**.
... ... @@ -161,6 +161,9 @@
161 161  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
162 162  [[image:1745928288556-250.png||alt="Réponse serveur"]]
163 163  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 +)))
164 164  
165 165  (% class="wikigeneratedid" %)
166 166  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.//
... ... @@ -181,7 +181,7 @@
181 181  Les ressources disponibles sont classées par type :
182 182  
183 183  * **Authentification **: pour la création des jetons de sécurité (JWT)
184 -* **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.
185 185  * **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
186 186  * **System** : pour les informations système, service d'audit et ordonnanceur.
187 187  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
... ... @@ -203,7 +203,7 @@
203 203  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
204 204  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
205 205  
206 -== Envoi de requêtes ==
211 +== Envoi de requêtes{{id name="envoi"/}} ==
207 207  
208 208  (% class="box warningmessage" %)
209 209  (((
... ... @@ -228,18 +228,21 @@
228 228  (% class="wikigeneratedid" id="HParamE8tres" %)
229 229  **Paramètres**
230 230  
231 -(% style="width:785px" %)
232 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
233 -|(% style="width:173px" %)includes|(% style="width:608px" %)Vous pouvez ajouter les rôles, autorisations (acls) et/ou groupes d'autorisations (groupacls) au résultat de la requête.
234 -|(% style="width:173px" %)id (obligatoire)|(% style="width:608px" %)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
235 -|(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
236 +(% style="width:1391px" %)
237 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**User management**
238 +|(% style="width:173px" %)includes|(% style="width:1214px" %)Vous pouvez ajouter les rôles, autorisations (acls) et/ou groupes d'autorisations (groupacls) au résultat de la requête.
239 +|(% style="width:173px" %)id (obligatoire)|(% style="width:1214px" %)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
240 +|(% 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.
236 236  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.
237 -|(% style="width:173px" %) |(% style="width:608px" %)
238 -|(% style="width:173px" %) |(% style="width:608px" %)
239 -|(% style="width:173px" %) |(% style="width:608px" %)
240 -|(% style="width:173px" %) |(% style="width:608px" %)
241 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
242 -|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
242 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Session management**
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.         
244 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Connection management**
245 +|(% 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.
246 +|(% 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.
247 +|(% style="width:173px" %)typeFilter|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données du ou des type(s) spécifiés ici.
248 +|(% style="width:173px" %)id (obligatoire)|(% style="width:1214px" %)Spécifiez l'identifiant de la connexion de base de données.
249 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**License management**
250 +|(% style="width:173px" %)pattern|(% style="width:1214px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
243 243  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
244 244  
245 245  = Expiration de l'authentification =
... ... @@ -252,3 +252,26 @@
252 252  1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
253 253  1. Cliquez sur** Close** pour **Fermer**.
254 254  1. Générez un nouveau jeton d'accès ou une nouvelle clé API comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
263 +
264 += Invalider un jeton JWT ou une clé API =
265 +
266 +== Invalider un jeton JWT ==
267 +
268 +Pour un jeton JWT, l'invalidation se fait de manière globale seulement en changeant la clé privée utilisée pour signer et la clé publique associée utilisée pour valider les signatures.
269 +
270 +== Invalider une clé API ==
271 +
272 +Pour une clé API, l'invalidation se fait de manière individuelle et globale.
273 +
274 +Pour invalider une ou plusieurs clés :
275 +
276 +(% start="1" %)
277 +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 :
278 +[[image:1745932166616-318.png||alt="Liste clés API"]]
279 +
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
281 +
282 +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.
283 +
284 +
285 +
1745932166616-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +44.5 KB
Content