Changes for page DigDash API REST

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

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -DigDash API REST
1 +Digdash API
Parent
... ... @@ -1,1 +1,0 @@
1 -Digdash.API.WebHome
Content
... ... @@ -11,16 +11,12 @@
11 11  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
12 12  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
13 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 :(((
14 +Pour ouvrir Swagger UI, utilisez le lien suivant :
19 19  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
20 20  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17 +
21 21  Par exemple:
22 -[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
23 -)))
19 +[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
24 24  
25 25  Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
26 26  
... ... @@ -30,9 +30,9 @@
30 30  )))
31 31  
32 32  (% class="wikigeneratedid" %)
33 -[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
29 +[[image:DD_API.png]]
34 34  
35 -= S'authentifier{{id name="Auth"/}} =
31 += S'authentifier =
36 36  
37 37  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
38 38  
... ... @@ -45,13 +45,10 @@
45 45  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
46 46  )))
47 47  * (((
48 -**BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
44 +**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
49 49  )))
50 -* (((
51 -**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
52 -)))
53 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.
47 +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.
55 55  
56 56  (% class="box warningmessage" %)
57 57  (((
... ... @@ -68,16 +68,11 @@
68 68  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
69 69  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
70 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 72  
73 -== S'authentifier via BearerAuth ==
65 +== Créer le jeton de sécurité ==
74 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.
67 +Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
76 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 81  1. Allez dans la section **Authentication**.
82 82  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
83 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.
... ... @@ -87,26 +87,24 @@
87 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 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 89  Par exemple :
90 -[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
78 +[[image:Requête_jwt.png||alt="Requête JWT"]]
91 91  
92 92  (% class="box warningmessage" %)
93 93  (((
94 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
82 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
95 95  )))
96 96  
97 97  (% start="5" %)
98 98  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
99 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"]]
88 +[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
101 101  1. Copiez le jeton JWT.
102 -
103 103  
104 -(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 -**Signature du jeton de sécurité**
91 +=== Signature du jeton de sécurité ===
106 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.
93 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
108 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 :
95 +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 :
110 110  
111 111  * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
112 112  * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
... ... @@ -116,7 +116,7 @@
116 116  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
117 117  
118 118  {{code language="shell"}}
119 -openssl genrsa -out /path/to/privatekey.pem 2048
105 +openssl -genrsa -out /path/to/privatekey.pem 2048
120 120  {{/code}}
121 121  
122 122  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
... ... @@ -125,65 +125,36 @@
125 125  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
126 126  {{/code}}
127 127  
128 -== S'authentifier via ApiKeyAuth ==
114 +== Authentification via BearerAuth ==
129 129  
130 -=== Créer une clé API ===
116 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
117 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
131 131  
132 -Nous allons créer ici une clé API :
133 -
134 -1. Allez dans la section **Authentication**.
135 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
136 -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.
137 -1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
138 -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é**.
139 -S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
140 -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]].
141 -1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
142 -Par exemple :
143 -[[image:1745928168043-553.png]]
144 -
145 -(% class="box warningmessage" %)
146 -(((
147 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
148 -)))
149 -
150 -(% start="5" %)
151 -1. Cliquez sur le bouton **Execute **pour générer la clé API.
152 -➡ La réponse s'affiche dans la section **Server response** en-dessous.
153 -[[image:1745928288556-250.png||alt="Réponse serveur"]]
154 -1. Copiez la clé API.
155 -
156 -=== S'authentifier ===
157 -
158 -Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
159 -
160 160  1. Cliquez sur le bouton **Authorize**.
161 -1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
162 -1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
120 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
121 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
163 163  1. Cliquez sur **Authorize**.
164 164  
165 -= Ressources API disponibles{{id name="ressources"/}} =
124 += API disponibles =
166 166  
167 -== Liste des ressources ==
126 +== Liste des API ==
168 168  
169 -Les ressources disponibles sont classées par type :
128 +Les API disponibles sont classées par type :
170 170  
171 -* **Authentification **: pour la création des jetons de sécurité (JWT)
172 -* **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.
173 -* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
174 -* **System** : pour les informations système, service d'audit et ordonnanceur.
175 -* **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
176 -* **Event Management** : pour l'ajout d'évènements avec fireEvent.
177 -* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
130 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
131 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
132 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
133 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
134 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
178 178  
179 179  (% class="box infomessage" %)
180 180  (((
181 -ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
138 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
182 182  )))
183 183  
184 184  == Opérations disponibles ==
185 185  
186 -Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
143 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
187 187  
188 188  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
189 189  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -193,26 +193,16 @@
193 193  
194 194  == Envoi de requêtes ==
195 195  
196 -(% class="box warningmessage" %)
197 -(((
198 -❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
199 -)))
200 -
201 201  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
202 202  (% 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 :
203 203  
204 -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é.
156 +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é.
205 205  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.
206 206  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) .
207 -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.
159 +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.
208 208  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.**(%%)
209 -➡ (% 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.
210 -Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
161 +➡ (% 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.
211 211  
212 -(% 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).
213 -À 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.
214 -[[image:1725441504464-493.png]]
215 -
216 216  (% class="wikigeneratedid" id="HParamE8tres" %)
217 217  **Paramètres**
218 218  
... ... @@ -220,23 +220,19 @@
220 220  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
221 221  |(% 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.
222 222  |(% 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.
223 -|(% 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.
224 -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.
225 -|(% style="width:173px" %) |(% style="width:608px" %)
226 -|(% style="width:173px" %) |(% style="width:608px" %)
227 -|(% style="width:173px" %) |(% style="width:608px" %)
228 -|(% style="width:173px" %) |(% style="width:608px" %)
170 +|(% 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.
171 +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.
229 229  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
230 230  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
231 231  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
232 232  
233 -= Expiration de l'authentification =
176 += Expiration et révocation de l'authentification =
234 234  
235 235  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
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".
237 -(% 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.
179 +(% 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 d'accès 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".
180 +(% 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 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. Pour invalider le jeton :
238 238  
239 239  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**.
240 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
241 -1. Cliquez sur** Close** pour **Fermer**.
242 -1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
183 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
184 +
185 +
1725441504464-493.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -25.3 KB
Content
1745927162186-776.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -8.7 KB
Content
1745928144436-696.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -8.4 KB
Content
1745928168043-553.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -8.1 KB
Content
1745928288556-250.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -43.6 KB
Content
DigDash_API.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -86.5 KB
Content
DigDash_API_token_creation_FR.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -13.6 KB
Content
DigDash_API_token_creation_response_FR.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -58.4 KB
Content