Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 35.1
edited by Aurelie Bertrand
on 2024/08/30 08:52
Change comment: There is no comment for this version
To version 90.1
edited by Aurelie Bertrand
on 2025/04/29 15:16
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Digdash API
1 +DigDash API REST
Parent
... ... @@ -1,0 +1,1 @@
1 +Digdash.API.WebHome
Content
... ... @@ -2,19 +2,27 @@
2 2  
3 3  ----
4 4  
5 +(% class="wikigeneratedid" %)
6 +DigDash propose une API REST pour interagir avec un certain nombre d'objets DigDash.
7 +Vous pouvez utiliser Swagger pour la tester.
8 +
5 5  = Accéder à Swagger UI =
6 6  
7 7  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
8 8  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
9 9  
10 -Pour ouvrir Swagger UI, utilisez le lien suivant :
14 +Pour ouvrir Swagger UI, vous pouvez :
15 +
16 +* cliquer sur le lien **API** présent en bas de la page d'accueil
17 +
18 +* utiliser le lien suivant :(((
11 11  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
12 12  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
13 -
14 14  Par exemple:
15 -[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
22 +[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
23 +)))
16 16  
17 -Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
25 +Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
18 18  
19 19  (% class="box infomessage" %)
20 20  (((
... ... @@ -21,8 +21,11 @@
21 21  💡 Dans le cas où le nom de domaine a été modifié, il est possible de spécifier un domaine ddapi personnalisé dans le champ **domain**.
22 22  )))
23 23  
24 -= S'authentifier =
32 +(% class="wikigeneratedid" %)
33 +[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
25 25  
35 += S'authentifier{{id name="Auth"/}} =
36 +
26 26  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
27 27  
28 28  * (% 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é.)(%%)
... ... @@ -34,10 +34,13 @@
34 34  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
35 35  )))
36 36  * (((
37 -**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
48 +**BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
38 38  )))
50 +* (((
51 +**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
52 +)))
39 39  
40 -La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification.
54 +La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité ou une clé API et utiliser l'une des deux autres méthodes.
41 41  
42 42  (% class="box warningmessage" %)
43 43  (((
... ... @@ -49,16 +49,21 @@
49 49  ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
50 50  )))
51 51  
52 -== Authentification via BasicAuth ==
66 +== S'authentifier via BasicAuth ==
53 53  
54 54  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
55 55  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
56 56  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
71 +Vous pouvez à présent créer un jeton JWT ou un clé API pour vous connecter.
57 57  
58 -== Création du jeton de sécurité ==
73 +== S'authentifier via BearerAuth ==
59 59  
60 -Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
75 +Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
61 61  
77 +=== Créer un jeton de sécurité ===
78 +
79 +Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
80 +
62 62  1. Allez dans la section **Authentication**.
63 63  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
64 64  1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
... ... @@ -68,24 +68,26 @@
68 68  1*. **expires** : (Optionnel mais recommandé) Indiquez la période de validité du JWT spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]].
69 69  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
70 70  Par exemple :
71 -[[image:Requête_jwt.png||alt="Requête JWT"]]
90 +[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
72 72  
73 73  (% class="box warningmessage" %)
74 74  (((
75 -❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
94 +❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
76 76  )))
77 77  
78 78  (% start="5" %)
79 79  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
80 80  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
81 -[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
100 +[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
82 82  1. Copiez le jeton JWT.
102 +
83 83  
84 -=== Signature du jeton de sécurité ===
104 +(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 +**Signature du jeton de sécurité**
85 85  
86 -Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
107 +Une clé privée utilisée pour signer le JWT est générée par défaut. Cette clé est temporaire et est régénérée à chaque redémarrage du serveur.
87 87  
88 -Pour des raisons de sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
109 +Pour éviter ce problème et améliorer la sécurité, il est vivement recommandé d'utiliser votre propre clé privée pour la signature des jetons JWT à l'aide des variables d'environnement suivantes :
89 89  
90 90  * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
91 91  * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
... ... @@ -95,7 +95,7 @@
95 95  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
96 96  
97 97  {{code language="shell"}}
98 -openssl -genrsa -out /path/to/privatekey.pem 2048
119 +openssl genrsa -out /path/to/privatekey.pem 2048
99 99  {{/code}}
100 100  
101 101  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
... ... @@ -104,36 +104,78 @@
104 104  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
105 105  {{/code}}
106 106  
107 -== Authentification via BearerAuth ==
128 +=== S'authentifier ===
108 108  
109 -(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
110 -(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
130 +Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
111 111  
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 +== S'authentifier via ApiKeyAuth ==
138 +
139 +=== Créer une clé API ===
140 +
141 +Nous allons créer ici une clé API :
142 +
143 +1. Allez dans la section **Authentication**.
144 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
145 +1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
146 +1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
147 +1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer la clé API dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
148 +S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
149 +1*. **expires** : (Optionnel) Indiquez la période de validité la clé API spécifiée sous la forme d'une période de temps au format ISO 8601 (c'est-à-dire PT5M pour 5 minutes). Pour plus d'informations, consultez [[https:~~/~~/en.wikipedia.org/wiki/ISO_8601#Durations>>https://en.wikipedia.org/wiki/ISO_8601#Durations]].
150 +1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
151 +Par exemple :
152 +[[image:1745928168043-553.png]]
153 +
154 +(% class="box warningmessage" %)
155 +(((
156 +❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
157 +)))
158 +
159 +(% start="5" %)
160 +1. Cliquez sur le bouton **Execute **pour générer la clé API.
161 +➡ La réponse s'affiche dans la section **Server response** en-dessous.
162 +[[image:1745928288556-250.png||alt="Réponse serveur"]]
163 +1. Copiez la clé API.
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 +=== S'authentifier ===
170 +
171 +Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
172 +
112 112  1. Cliquez sur le bouton **Authorize**.
113 -1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
114 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
174 +1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
175 +1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
115 115  1. Cliquez sur **Authorize**.
116 116  
117 -= API disponibles =
178 += Ressources API disponibles{{id name="ressources"/}} =
118 118  
119 -== Liste des API ==
180 +== Liste des ressources ==
120 120  
121 -Les API disponibles sont classées par type :
182 +Les ressources disponibles sont classées par type :
122 122  
123 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
124 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
125 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
126 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
127 -* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
184 +* **Authentification **: pour la création des jetons de sécurité (JWT)
185 +* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autosations des rôles, etc.
186 +* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
187 +* **System** : pour les informations système, service d'audit et ordonnanceur.
188 +* **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
189 +* **Event Management** : pour l'ajout d'évènements avec fireEvent.
190 +* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
128 128  
129 129  (% class="box infomessage" %)
130 130  (((
131 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
194 +ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
132 132  )))
133 133  
134 134  == Opérations disponibles ==
135 135  
136 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
199 +Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
137 137  
138 138  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
139 139  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -143,16 +143,26 @@
143 143  
144 144  == Envoi de requêtes ==
145 145  
209 +(% class="box warningmessage" %)
210 +(((
211 +❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
212 +)))
213 +
146 146  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
147 147  (% 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 vous y êtes autorisé, vous pouvez effectuer des requêtes :
148 148  
149 -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" %)Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
217 +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" %)Développez une ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
150 150  1. Avant de commencer, vous pouvez visualiser un exemple de requête et en passant sur l'onglet **Schema**, une description des différents éléments.
151 151  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" %)Dans la fenêtre de méthode développée, cliquez sur **Try it out **(Essayer) .
152 -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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée ci-dessous.
220 +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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée dans le tableau ci-dessous.
153 153  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 **Execute.**(%%)
154 -➡ (% 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 requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
222 +➡ (% 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 requête est exécutée et la réponse s'affiche.
223 +Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
155 155  
225 +(% id="cke_bm_11947S" style="display:none" %) (%%)Swagger propose également des lignes de commande curl lors de l'exécution des requêtes afin d'aider à tester ou coder un outil en dehors du navigateur (dans un script par exemple).
226 +À noter qu'il faut spécifier, que soit pour curl ou un autre outil, les entêtes HTTP "Accept" (format du contenu à récupérer) et "Content-Type" (format du contenu envoyé) pour que les requêtes fonctionnent correctement. Ces deux entêtes peuvent prendre les valeurs "application/json" pour du json ou "application/xml" pour du xml.
227 +[[image:1725441504464-493.png]]
228 +
156 156  (% class="wikigeneratedid" id="HParamE8tres" %)
157 157  **Paramètres**
158 158  
... ... @@ -160,20 +160,46 @@
160 160  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
161 161  |(% 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.
162 162  |(% 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.
163 -|(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seraont affichées.
164 -Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seont affichés et non pas les rôles propres à l'utilisateur.
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 +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" %)
165 165  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
166 166  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
167 167  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
168 168  
169 -
246 += Expiration de l'authentification =
170 170  
171 -= Expiration et révocation de l'authentification =
172 -
173 173  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
174 -(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Lorsque le jeton d'accès expire, vous recevez une réponse (% style="font-size: 10pt; font-variant: normal; white-space: pre-wrap; font-family: ~"Roboto Mono~", monospace; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)401:(%%) "Unauthorized".
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".
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.
175 175  
176 -(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
177 -(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :
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**.
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"]].
178 178  
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"]]
179 179  
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 +
1725441504464-493.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +25.3 KB
Content
1745927162186-776.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +8.7 KB
Content
1745928144436-696.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +8.4 KB
Content
1745928168043-553.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +8.1 KB
Content
1745928288556-250.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +43.6 KB
Content
1745932166616-318.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +44.5 KB
Content
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.1 KB
Content
DigDash_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +86.5 KB
Content
DigDash_API_token_creation_FR.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +13.6 KB
Content
DigDash_API_token_creation_response_FR.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +58.4 KB
Content