Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 1.1
edited by Aurelie Bertrand
on 2024/08/28 14:19
Change comment: There is no comment for this version
To version 86.1
edited by Aurelie Bertrand
on 2025/04/29 14:49
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
... ... @@ -1,0 +1,255 @@
1 +{{ddtoc/}}
2 +
3 +----
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 +
9 += Accéder à Swagger UI =
10 +
11 +Swagger UI permet de visualiser et d'interagir avec les ressources des API.
12 +Cette interface fournit également une documentation visuelle facilitant leur utilisation.
13 +
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 :(((
19 +[[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
20 +dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
21 +Par exemple:
22 +[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
23 +)))
24 +
25 +Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
26 +
27 +(% class="box infomessage" %)
28 +(((
29 +💡 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**.
30 +)))
31 +
32 +(% class="wikigeneratedid" %)
33 +[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
34 +
35 += S'authentifier{{id name="Auth"/}} =
36 +
37 +Afin de pouvoir interagir avec les API, vous devez vous authentifier.
38 +
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 +➡ (% 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 +
42 +Deux méthodes d'autorisation sont actuellement disponibles :
43 +
44 +* (((
45 +**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
46 +)))
47 +* (((
48 +**BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
49 +)))
50 +* (((
51 +**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
52 +)))
53 +
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.
55 +
56 +(% class="box warningmessage" %)
57 +(((
58 +❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
59 +)))
60 +
61 +(% class="box infomessage" %)
62 +(((
63 +ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
64 +)))
65 +
66 +== S'authentifier via BasicAuth ==
67 +
68 +1. Entrez votre nom d'utilisateur et mot de passe Digdash.
69 +1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
70 +➡ 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.
72 +
73 +== S'authentifier via BearerAuth ==
74 +
75 +Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
76 +
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 +
81 +1. Allez dans la section **Authentication**.
82 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
83 +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.
84 +1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
85 +1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer le JWT dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
86 +S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
87 +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]].
88 +1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
89 +Par exemple :
90 +[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
91 +
92 +(% class="box warningmessage" %)
93 +(((
94 +❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
95 +)))
96 +
97 +(% start="5" %)
98 +1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
99 +➡ La réponse s'affiche dans la section **Server response** en-dessous.
100 +[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
101 +1. Copiez le jeton JWT.
102 +
103 +
104 +(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 +**Signature du jeton de sécurité**
106 +
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.
108 +
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 :
110 +
111 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
112 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
113 +
114 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
115 +
116 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
117 +
118 +{{code language="shell"}}
119 +openssl genrsa -out /path/to/privatekey.pem 2048
120 +{{/code}}
121 +
122 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
123 +
124 +{{code language="shell"}}
125 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 +{{/code}}
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 +== 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 +
173 +1. Cliquez sur le bouton **Authorize**.
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.
176 +1. Cliquez sur **Authorize**.
177 +
178 += Ressources API disponibles{{id name="ressources"/}} =
179 +
180 +== Liste des ressources ==
181 +
182 +Les ressources disponibles sont classées par type :
183 +
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.
191 +
192 +(% class="box infomessage" %)
193 +(((
194 +ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
195 +)))
196 +
197 +== Opérations disponibles ==
198 +
199 +Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
200 +
201 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
202 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
203 +* (% style="color:#16a085" %)**PATCH**(%%)** **: pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
204 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
205 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
206 +
207 +== Envoi de requêtes ==
208 +
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 +
214 +(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
215 +(% 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 :
216 +
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é.
218 +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.
219 +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) .
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.
221 +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.**(%%)
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.
224 +
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 +
229 +(% class="wikigeneratedid" id="HParamE8tres" %)
230 +**Paramètres**
231 +
232 +(% style="width:785px" %)
233 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
234 +|(% 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.
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 +|(% 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" %)
242 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
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 +Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
245 +
246 += Expiration de l'authentification =
247 +
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".
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 +
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"]].
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
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
Requête_jwt.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +7.6 KB
Content
Réponse_requête_JWT.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +46.9 KB
Content