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 92.1
edited by Aurelie Bertrand
on 2025/04/29 15:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -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 :
... ... @@ -242,10 +242,33 @@
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".
252 +(% 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**.
256 +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"]].
258 +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"]].
259 +
260 += Invalider un jeton JWT ou une clé API =
261 +
262 +== Invalider un jeton JWT ==
263 +
264 +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.
265 +
266 +== Invalider une clé API ==
267 +
268 +Pour une clé API, l'invalidation se fait de manière individuelle et globale.
269 +
270 +Pour invalider une ou plusieurs clés :
271 +
272 +(% start="1" %)
273 +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 :
274 +[[image:1745932166616-318.png||alt="Liste clés API"]]
275 +
276 +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.
277 +
278 +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.
279 +
280 +
281 +
1745932166616-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +44.5 KB
Content