Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 62.1
edited by Aurelie Bertrand
on 2024/09/23 15:03
Change comment: There is no comment for this version
To version 25.1
edited by Aurelie Bertrand
on 2024/08/29 15:56
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
... ... @@ -2,10 +2,6 @@
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 -
9 9  = Accéder à Swagger UI =
10 10  
11 11  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
... ... @@ -16,20 +16,12 @@
16 16  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17 17  
18 18  Par exemple:
19 -[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
15 +[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
20 20  
21 -Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
17 +Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
22 22  
23 -(% class="box infomessage" %)
24 -(((
25 -💡 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**.
26 -)))
19 += S'authentifier =
27 27  
28 -(% class="wikigeneratedid" %)
29 -[[image:DD_API.png]]
30 -
31 -= S'authentifier{{id name="Auth"/}} =
32 -
33 33  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
34 34  
35 35  * (% 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é.)(%%)
... ... @@ -41,10 +41,10 @@
41 41  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
42 42  )))
43 43  * (((
44 -**BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
32 +**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
45 45  )))
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.
35 +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.
48 48  
49 49  (% class="box warningmessage" %)
50 50  (((
... ... @@ -56,18 +56,18 @@
56 56  ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
57 57  )))
58 58  
59 -== S'authentifier via BasicAuth ==
47 +== Authentification via BasicAuth ==
60 60  
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é.
64 64  
65 -== Créer le jeton de sécurité ==
53 +== Création du jeton de sécurité ==
66 66  
67 67  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
68 68  
69 69  1. Allez dans la section **Authentication**.
70 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
58 +1. Cliquez sur **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.
72 72  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
73 73  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é**.
... ... @@ -79,7 +79,7 @@
79 79  
80 80  (% class="box warningmessage" %)
81 81  (((
82 -❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
70 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
83 83  )))
84 84  
85 85  (% start="5" %)
... ... @@ -111,36 +111,36 @@
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 ==
102 +== Authentification via BearerAuth ==
115 115  
116 116  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
117 117  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
118 118  
119 119  1. Cliquez sur le bouton **Authorize**.
120 -1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
108 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
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 =
112 += API disponibles =
125 125  
126 -== Liste des ressources ==
114 +== Liste des API ==
127 127  
128 -Les ressources disponibles sont classées par type :
116 +Les API disponibles sont classées par type :
129 129  
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.
132 -* **System** : pour les informations système, service d'audit et ordonnanceur.
133 -* **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
134 -* **Event Management** : pour l'ajout d'évènements avec fireEvent.
118 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
119 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
120 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
121 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
122 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
135 135  
136 136  (% class="box infomessage" %)
137 137  (((
138 -ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
126 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
139 139  )))
140 140  
141 141  == Opérations disponibles ==
142 142  
143 -Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
131 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
144 144  
145 145  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
146 146  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -150,46 +150,5 @@
150 150  
151 151  == Envoi de requêtes ==
152 152  
153 -(% class="box warningmessage" %)
154 -(((
155 -❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
156 -)))
157 157  
158 -(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
159 -(% 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 :
160 -
161 -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é.
162 -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.
163 -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) .
164 -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.
165 -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.**(%%)
166 -➡ (% 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.
167 -Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
168 -
169 -(% 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).
170 -À 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.
171 -[[image:1725441504464-493.png]]
172 -
173 -(% class="wikigeneratedid" id="HParamE8tres" %)
174 -**Paramètres**
175 -
176 -(% style="width:785px" %)
177 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
178 -|(% 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.
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 -|(% 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 -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.
182 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
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 -Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
185 -
186 -= Expiration de l'authentification =
187 -
188 -(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
189 -(% 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".
190 -(% 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.
191 -
192 -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**.
193 -1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
194 -1. Cliquez sur** Close** pour **Fermer**.
195 -1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
142 +
1725441504464-493.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -25.3 KB
Content
DD_API.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -63.1 KB
Content