Wiki source code of Digdash API

Version 45.1 by Aurelie Bertrand on 2024/08/30 09:51
Show last authors
1 {{ddtoc/}}
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
11 Swagger UI permet de visualiser et d'interagir avec les ressources des API.
12 Cette interface fournit également une documentation visuelle facilitant leur utilisation.
13
14 Pour ouvrir Swagger UI, utilisez le lien suivant :
15 [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
16 dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
17
18 Par exemple:
19 [[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
20
21 Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
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 )))
27
28 (% class="wikigeneratedid" %)
29 [[image:DD_API.png]]
30
31 = S'authentifier =
32
33 Afin de pouvoir interagir avec les API, vous devez vous authentifier.
34
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é.)(%%)
36 ➡ (% 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 fenêtre (%%)**Available authorizations** ((% 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" %)Autorisations disponibles) s'affiche.
37
38 Deux méthodes d'autorisation sont actuellement disponibles :
39
40 * (((
41 **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
42 )))
43 * (((
44 **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
45 )))
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.
48
49 (% class="box warningmessage" %)
50 (((
51 ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
52 )))
53
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
59 == S'authentifier via BasicAuth ==
60
61 1. Entrez votre nom d'utilisateur et mot de passe Digdash.
62 1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
63 ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
64
65 == Créer le jeton de sécurité ==
66
67 Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
68
69 1. Allez dans la section **Authentication**.
70 1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
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 1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
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é**.
74 S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
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 1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
77 Par exemple :
78 [[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" %)
86 1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
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"]]
89 1. Copiez le jeton JWT.
90
91 === Signature du jeton de sécurité ===
92
93 Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
94
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 :
96
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 == S'authentifier 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
119 1. Cliquez sur le bouton **Authorize**.
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**.
122 1. Cliquez sur **Authorize**.
123
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 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 invalider le jeton expiré et générer un nouveau jeton d'accès.
181
182 (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
183 De même l(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)orsque vous avez terminé de travailler avec l'interface Swagger, vous devez invalider le jeton d'accès que vous avez utilisé.
184
185 (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
186 (% 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" %)Pour invalider le jeton de sécurité :
187
188 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**.
189 1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
190 1. Cliquez sur** Close** pour **Fermer**.
191
192