Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 82.1
edited by Aurelie Bertrand
on 2025/04/29 14:24
Change comment: There is no comment for this version
To version 94.3
edited by Aurelie Bertrand
on 2025/04/29 16:10
Change comment: There is no comment for this version

Summary

Details

Page properties
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.
... ... @@ -136,6 +136,9 @@
136 136  
137 137  == S'authentifier via ApiKeyAuth ==
138 138  
139 +
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 +
139 139  === Créer une clé API ===
140 140  
141 141  Nous allons créer ici une clé API :
... ... @@ -162,6 +162,10 @@
162 162  [[image:1745928288556-250.png||alt="Réponse serveur"]]
163 163  1. Copiez la clé API.
164 164  
168 +(% class="wikigeneratedid" %)
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 +
165 165  === S'authentifier ===
166 166  
167 167  Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
... ... @@ -225,27 +225,53 @@
225 225  (% class="wikigeneratedid" id="HParamE8tres" %)
226 226  **Paramètres**
227 227  
228 -(% style="width:785px" %)
229 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
230 -|(% 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.
231 -|(% 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.
232 -|(% 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.
235 +(% style="width:1391px" %)
236 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**User management**
237 +|(% 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.
238 +|(% 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.
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.
233 233  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.
234 -|(% style="width:173px" %) |(% style="width:608px" %)
235 -|(% style="width:173px" %) |(% style="width:608px" %)
236 -|(% style="width:173px" %) |(% style="width:608px" %)
237 -|(% style="width:173px" %) |(% style="width:608px" %)
238 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
239 -|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
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 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Connection management**
244 +|(% style="width:173px" %)itemRole|(% style="width:1214px" %)
245 +|(% style="width:173px" %)nameFilter|(% style="width:1214px" %)
246 +|(% style="width:173px" %)typeFilter|(% style="width:1214px" %)
247 +|(% style="width:173px" %)id|(% style="width:1214px" %)
248 +|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**License management**
249 +|(% style="width:173px" %)pattern|(% style="width:1214px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
240 240  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
241 241  
242 242  = Expiration de l'authentification =
243 243  
244 244  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
245 -(% 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" %)Lorsque le jeton de sécurité (JWT) expire, vous recevez une réponse (% style="color:#182027; font-family:~"Roboto Mono~",monospace; font-size:10pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)401:(%%) "Unauthorized".
255 +(% 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" %)Lorsque le jeton de sécurité (JWT) ou la clé API expire, vous recevez une réponse (% style="color:#182027; font-family:~"Roboto Mono~",monospace; font-size:10pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)401:(%%) "Unauthorized".
246 246  (% 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" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton a expiré. Lorsque cela se produit, vous devez vous déconnecter de (%%)BearerAuth** **(% 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" %)et générer un nouveau jeton d'accès.
247 247  
248 248  1. (% 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** pour ouvrir la fenêtre **Available authorizations**.
249 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
259 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
250 250  1. Cliquez sur** Close** pour **Fermer**.
251 -1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
261 +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"]].
262 +
263 += Invalider un jeton JWT ou une clé API =
264 +
265 +== Invalider un jeton JWT ==
266 +
267 +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.
268 +
269 +== Invalider une clé API ==
270 +
271 +Pour une clé API, l'invalidation se fait de manière individuelle et globale.
272 +
273 +Pour invalider une ou plusieurs clés :
274 +
275 +(% start="1" %)
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 +[[image:1745932166616-318.png||alt="Liste clés API"]]
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 +
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 +
283 +
284 +
1745932166616-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +44.5 KB
Content