Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 63.1
edited by Aurelie Bertrand
on 2024/11/28 10:23
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
... ... @@ -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  
... ... @@ -43,8 +43,11 @@
43 43  * (((
44 44  **BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
45 45  )))
50 +* (((
51 +**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
52 +)))
46 46  
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 BeareAuth.
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.
48 48  
49 49  (% class="box warningmessage" %)
50 50  (((
... ... @@ -61,11 +61,16 @@
61 61  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
62 62  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
63 63  ➡ 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.
64 64  
65 -== Créer le jeton de sécurité ==
73 +== S'authentifier via BearerAuth ==
66 66  
67 -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.
68 68  
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 +
69 69  1. Allez dans la section **Authentication**.
70 70  1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
71 71  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.
... ... @@ -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"]]
90 +[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
79 79  
80 80  (% class="box warningmessage" %)
81 81  (((
... ... @@ -85,12 +85,14 @@
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"]]
100 +[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
89 89  1. Copiez le jeton JWT.
102 +
90 90  
91 -=== Signature du jeton de sécurité ===
104 +(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
105 +**Signature du jeton de sécurité**
92 92  
93 -Une clé privée utilisée pour signer le JWT est générée par défaut. Cette clé est transitoire et doit être regénérée à chaque redémarrage du serveur.
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.
94 94  
95 95  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 :
96 96  
... ... @@ -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
119 +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):
... ... @@ -111,17 +111,44 @@
111 111  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
112 112  {{/code}}
113 113  
114 -== S'authentifier via BearerAuth ==
128 +== S'authentifier via ApiKeyAuth ==
115 115  
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 :
130 +=== Créer une clé API ===
118 118  
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 +
119 119  1. Cliquez sur le bouton **Authorize**.
120 120  1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
121 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
162 +1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
122 122  1. Cliquez sur **Authorize**.
123 123  
124 -= Ressources API disponibles =
165 += 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.
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.
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.
177 +* **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.
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" %)
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.
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
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