Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 64.1
edited by Aurelie Bertrand
on 2024/11/28 10:48
Change comment: There is no comment for this version
To version 74.1
edited by Aurelie Bertrand
on 2025/04/25 14:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -11,12 +11,16 @@
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, 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 :(((
15 15  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
16 16  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17 -
18 18  Par exemple:
19 19  [[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
23 +)))
20 20  
21 21  Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
22 22  
... ... @@ -26,7 +26,7 @@
26 26  )))
27 27  
28 28  (% class="wikigeneratedid" %)
29 -[[image:DD_API.png]]
33 +[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
30 30  
31 31  = S'authentifier{{id name="Auth"/}} =
32 32  
... ... @@ -75,7 +75,7 @@
75 75  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]].
76 76  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
77 77  Par exemple :
78 -[[image:Requête_jwt.png||alt="Requête JWT"]]
82 +[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
79 79  
80 80  (% class="box warningmessage" %)
81 81  (((
... ... @@ -85,7 +85,7 @@
85 85  (% start="5" %)
86 86  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
87 87  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
88 -[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
92 +[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
89 89  1. Copiez le jeton JWT.
90 90  
91 91  === Signature du jeton de sécurité ===
... ... @@ -102,7 +102,7 @@
102 102  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
103 103  
104 104  {{code language="shell"}}
105 -openssl -genrsa -out /path/to/privatekey.pem 2048
109 +openssl genrsa -out /path/to/privatekey.pem 2048
106 106  {{/code}}
107 107  
108 108  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
... ... @@ -121,7 +121,7 @@
121 121  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
122 122  1. Cliquez sur **Authorize**.
123 123  
124 -= Ressources API disponibles =
128 += Ressources API disponibles{{id name="ressources"/}} =
125 125  
126 126  == Liste des ressources ==
127 127  
... ... @@ -128,10 +128,12 @@
128 128  Les ressources disponibles sont classées par type :
129 129  
130 130  * **Authentification **: pour la création des jetons de sécurité (JWT)
131 -* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
135 +* **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.
136 +* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
132 132  * **System** : pour les informations système, service d'audit et ordonnanceur.
133 133  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
134 134  * **Event Management** : pour l'ajout d'évènements avec fireEvent.
140 +* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
135 135  
136 136  (% class="box infomessage" %)
137 137  (((
... ... @@ -179,6 +179,10 @@
179 179  |(% 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.
180 180  |(% 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.
181 181  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.
188 +|(% style="width:173px" %) |(% style="width:608px" %)
189 +|(% style="width:173px" %) |(% style="width:608px" %)
190 +|(% style="width:173px" %) |(% style="width:608px" %)
191 +|(% style="width:173px" %) |(% style="width:608px" %)
182 182  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
183 183  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
184 184  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
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