Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 89.1
edited by Aurelie Bertrand
on 2025/04/29 15:09
Change comment: Ajout du fichier 1745932166616-318.png
To version 93.1
edited by Aurelie Bertrand
on 2025/04/29 15:37
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 :
... ... @@ -235,10 +235,12 @@
235 235  |(% 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.
236 236  |(% 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.
237 237  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.
238 -|(% style="width:173px" %) |(% style="width:608px" %)
239 -|(% style="width:173px" %) |(% style="width:608px" %)
240 -|(% style="width:173px" %) |(% style="width:608px" %)
241 -|(% style="width:173px" %) |(% style="width:608px" %)
241 +|(% colspan="2" style="background-color:grey; text-align:center; width:173px" %)(% style="color:#ffffff" %)**Session management**
242 +|(% style="width:173px" %)users|(% style="width:608px" %)
243 +|(% colspan="2" style="background-color:grey; text-align:center; width:173px" %)(% style="color:#ffffff" %)**Connection management**
244 +|(% style="width:173px" %)itemRole|(% style="width:608px" %)
245 +|(% style="width:173px" %)nameFilter|(% style="width:608px" %)
246 +|(% style="width:173px" %)typeFilter|(% style="width:608px" %)
242 242  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
243 243  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
244 244  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
... ... @@ -256,11 +256,23 @@
256 256  
257 257  = Invalider un jeton JWT ou une clé API =
258 258  
264 +== Invalider un jeton JWT ==
265 +
259 259  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.
260 260  
268 +== Invalider une clé API ==
269 +
261 261  Pour une clé API, l'invalidation se fait de manière individuelle et globale.
262 -Pour invalider une ou plusieurs clés, vous pouvez tout d'abord récupérer la liste des clés en utilisant l'enpoint GET /api/v1/auth/apikeys
263 263  
264 -Les clés sont stockées côté serveur dans un fichier csv (pas de cache car stateful) donc l'invalidation individuelle est possible soit via l'endpoint prévu (POST /api/v1/auth/apikeys/delete), soit en modifiant le fichier serveur éteint. L'invalidation globale consiste tout simplement à invalider toutes les clés ou effacer le fichier csv serveur éteint.
272 +Pour invalider une ou plusieurs clés :
265 265  
274 +(% start="1" %)
275 +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 :
276 +[[image:1745932166616-318.png||alt="Liste clés API"]]
266 266  
278 +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.
279 +
280 +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.
281 +
282 +
283 +