Modifications pour le document DigDash API REST

Modifié par Aurelie Bertrand le 2025/11/13 09:18
Depuis la version 94.2
modifié par Aurelie Bertrand
sur 2025/04/29 15:54
Commentaire de modification : Il n'y a aucun commentaire pour cette version
À la version 88.1
modifié par Aurelie Bertrand
sur 2025/04/29 15:07
Commentaire de modification : Il n'y a aucun commentaire pour cette version

Résumé

Détails

Propriétés de la Page
Contenu
... ... @@ -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 -Trois méthodes d'autorisation sont disponibles :
42 +Deux méthodes d'autorisation sont actuellement 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,9 +136,6 @@
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 -
142 142  === Créer une clé API ===
143 143  
144 144  Nous allons créer ici une clé API :
... ... @@ -238,13 +238,10 @@
238 238  |(% 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.
239 239  |(% 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.
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 -|(% 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" %)
247 -|(% style="width:173px" %)id|(% 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 +|(% style="width:173px" %) |(% style="width:608px" %)
248 248  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
249 249  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
250 250  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
... ... @@ -262,23 +262,11 @@
262 262  
263 263  = Invalider un jeton JWT ou une clé API =
264 264  
265 -== Invalider un jeton JWT ==
266 -
267 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 268  
269 -== Invalider une clé API ==
270 -
271 271  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
272 272  
273 -Pour invalider une ou plusieurs clés :
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.
274 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 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
Auteur
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Taille
... ... @@ -1,1 +1,0 @@
1 -44.5 KB
Contenu