Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 7.1
edited by Aurelie Bertrand
on 2024/08/29 11:45
Change comment: There is no comment for this version
To version 37.1
edited by Aurelie Bertrand
on 2024/08/30 09:19
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,13 @@
1 -= Ouvrir Swagger UI =
1 +{{ddtoc/}}
2 2  
3 +----
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 += Accéder à Swagger UI =
10 +
3 3  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 4  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
5 5  
... ... @@ -10,8 +10,16 @@
10 10  Par exemple:
11 11  [[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
12 12  
13 -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.
14 14  
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||height="638" width="1064"]]
30 +
15 15  = S'authentifier =
16 16  
17 17  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -22,7 +22,7 @@
22 22  Deux méthodes d'autorisation sont actuellement disponibles :
23 23  
24 24  * (((
25 -**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
41 +**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 26  )))
27 27  * (((
28 28  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -35,6 +35,11 @@
35 35  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36 36  )))
37 37  
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 +)))
58 +
38 38  == Authentification via BasicAuth ==
39 39  
40 40  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
... ... @@ -46,7 +46,7 @@
46 46  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
47 47  
48 48  1. Allez dans la section **Authentication**.
49 -1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
70 +1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
50 50  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.
51 51  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
52 52  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é**.
... ... @@ -55,21 +55,109 @@
55 55  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
56 56  Par exemple :
57 57  [[image:Requête_jwt.png||alt="Requête JWT"]]
79 +
80 +(% class="box warningmessage" %)
81 +(((
82 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
83 +)))
84 +
85 +(% start="5" %)
58 58  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
59 59  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
60 60  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61 61  1. Copiez le jeton JWT.
62 62  
63 -== Authentification via BasicAuth ==
91 +=== Signature du jeton de sécurité ===
64 64  
65 -1. Entrez votre nom d'utilisateur et mot de passe Digdash.
66 -1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
67 -➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
93 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
68 68  
69 -Vous pouvez alors vous authentifier via la seconde méthode :
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 :
70 70  
97 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
98 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
99 +
100 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
101 +
102 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
103 +
104 +{{code language="shell"}}
105 +openssl -genrsa -out /path/to/privatekey.pem 2048
106 +{{/code}}
107 +
108 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
109 +
110 +{{code language="shell"}}
111 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
112 +{{/code}}
113 +
114 +== Authentification via BearerAuth ==
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 :
118 +
71 71  1. Cliquez sur le bouton **Authorize**.
72 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton.
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**.
73 73  1. Cliquez sur **Authorize**.
74 74  
124 += API disponibles =
125 +
126 +== Liste des API ==
127 +
128 +Les API disponibles sont classées par type :
129 +
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.
135 +
136 +(% class="box infomessage" %)
137 +(((
138 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
139 +)))
140 +
141 +== Opérations disponibles ==
142 +
143 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
144 +
145 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
146 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
147 +* (% style="color:#16a085" %)**PATCH**(%%)** **: pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
148 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
149 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
150 +
151 +== Envoi de requêtes ==
152 +
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 :
155 +
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é.
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 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.
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 et révocation 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 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 +
181 +(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
182 +(% 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 :
183 +
75 75  
DD_API.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +63.0 KB
Content