Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 22.1
edited by Aurelie Bertrand
on 2024/08/29 15:43
Change comment: There is no comment for this version
To version 54.1
edited by Aurelie Bertrand
on 2024/09/04 10:54
Change comment: There is no comment for this version

Summary

Details

Page properties
Title
... ... @@ -1,1 +1,1 @@
1 -Digdash API
1 +DigDash API
Parent
... ... @@ -1,0 +1,1 @@
1 +Digdash.API.WebHome
Content
... ... @@ -2,6 +2,10 @@
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 +
5 5  = Accéder à Swagger UI =
6 6  
7 7  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
... ... @@ -12,10 +12,18 @@
12 12  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
13 13  
14 14  Par exemple:
15 -[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
19 +[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
16 16  
17 -Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
21 +Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
18 18  
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 +)))
27 +
28 +(% class="wikigeneratedid" %)
29 +[[image:DD_API.png]]
30 +
19 19  = S'authentifier =
20 20  
21 21  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -29,7 +29,7 @@
29 29  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
30 30  )))
31 31  * (((
32 -**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.
33 33  )))
34 34  
35 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.
... ... @@ -39,18 +39,23 @@
39 39  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
40 40  )))
41 41  
42 -== Authentification via BasicAuth ==
54 +(% class="box infomessage" %)
55 +(((
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 +)))
43 43  
59 +== S'authentifier via BasicAuth ==
60 +
44 44  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
45 45  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
46 46  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
47 47  
48 -== Création du jeton de sécurité ==
65 +== Créer le jeton de sécurité ==
49 49  
50 50  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
51 51  
52 52  1. Allez dans la section **Authentication**.
53 -1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
70 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
54 54  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.
55 55  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
56 56  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é**.
... ... @@ -94,36 +94,36 @@
94 94  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
95 95  {{/code}}
96 96  
97 -== Authentification via BearerAuth ==
114 +== S'authentifier via BearerAuth ==
98 98  
99 99  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
100 100  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
101 101  
102 102  1. Cliquez sur le bouton **Authorize**.
103 -1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
120 +1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
104 104  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
105 105  1. Cliquez sur **Authorize**.
106 106  
107 -= API disponibles =
124 += Ressources API disponibles =
108 108  
109 -== Liste des API ==
126 +== Liste des ressources ==
110 110  
111 -Les API disponibles sont classées par type :
128 +Les ressources disponibles sont classées par type :
112 112  
113 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
114 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
115 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
116 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
117 -* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
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 118  
119 119  (% class="box infomessage" %)
120 120  (((
121 -ℹ Le cadenas fermé signifie que vous avez les droits sur l'API dans le JWT.
138 +ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
122 122  )))
123 123  
124 124  == Opérations disponibles ==
125 125  
126 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
143 +Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
127 127  
128 128  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
129 129  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
... ... @@ -131,7 +131,38 @@
131 131  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
132 132  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
133 133  
134 -== Envoi d'une requête ==
151 +== Envoi de requêtes ==
135 135  
153 +(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
154 +(% 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 :
136 136  
137 -
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 ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
157 +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.
158 +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) .
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.
160 +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.**(%%)
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.
162 +
163 +(% class="wikigeneratedid" id="HParamE8tres" %)
164 +**Paramètres**
165 +
166 +(% style="width:785px" %)
167 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
168 +|(% 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.
169 +|(% 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.
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 seront affichées.
171 +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.
172 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
173 +|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
174 +Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
175 +
176 += Expiration de l'authentification =
177 +
178 +(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
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 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".
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 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.
181 +
182 +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**.
183 +1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
184 +1. Cliquez sur** Close** pour **Fermer**.
185 +1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>S'authentifier||anchor="Auth"]].
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.1 KB
Content