Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 90.1
edited by Aurelie Bertrand
on 2025/04/29 15:16
Change comment: There is no comment for this version
To version 81.1
edited by Aurelie Bertrand
on 2025/04/29 14:22
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -125,15 +125,6 @@
125 125  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 126  {{/code}}
127 127  
128 -=== S'authentifier ===
129 -
130 -Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
131 -
132 -1. Cliquez sur le bouton **Authorize**.
133 -1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
134 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
135 -1. Cliquez sur **Authorize**.
136 -
137 137  == S'authentifier via ApiKeyAuth ==
138 138  
139 139  === Créer une clé API ===
... ... @@ -162,10 +162,6 @@
162 162  [[image:1745928288556-250.png||alt="Réponse serveur"]]
163 163  1. Copiez la clé API.
164 164  
165 -(% class="wikigeneratedid" %)
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.//
167 -La clé est hashée et ne peut donc être récupérée.
168 -
169 169  === S'authentifier ===
170 170  
171 171  Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
... ... @@ -246,33 +246,10 @@
246 246  = Expiration de l'authentification =
247 247  
248 248  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
249 -(% 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".
236 +(% 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".
250 250  (% 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.
251 251  
252 252  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**.
253 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
240 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
254 254  1. Cliquez sur** Close** pour **Fermer**.
255 -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"]].
256 -
257 -= Invalider un jeton JWT ou une clé API =
258 -
259 -== Invalider un jeton JWT ==
260 -
261 -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.
262 -
263 -== Invalider une clé API ==
264 -
265 -Pour une clé API, l'invalidation se fait de manière individuelle et globale.
266 -
267 -Pour invalider une ou plusieurs clés :
268 -
269 -(% start="1" %)
270 -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 :
271 -[[image:1745932166616-318.png||alt="Liste clés API"]]
272 -
273 -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.
274 -
275 -Pour invalider toutes les clés API, supprimez toutes les clés comme ci-dessus ou supprimer le fichier csv contenant les clés avec le serveur éteint.
276 -
277 -
278 -
242 +1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
1745932166616-318.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -44.5 KB
Content