Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 35.1
edited by Aurelie Bertrand
on 2024/08/30 08:52
Change comment: There is no comment for this version
To version 9.1
edited by Aurelie Bertrand
on 2024/08/29 12:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,9 +1,5 @@
1 -{{ddtoc/}}
1 += Ouvrir Swagger UI =
2 2  
3 -----
4 -
5 -= Accéder à Swagger UI =
6 -
7 7  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
8 8  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
9 9  
... ... @@ -16,11 +16,6 @@
16 16  
17 17  Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
18 18  
19 -(% class="box infomessage" %)
20 -(((
21 -💡 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**.
22 -)))
23 -
24 24  = S'authentifier =
25 25  
26 26  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
... ... @@ -31,7 +31,7 @@
31 31  Deux méthodes d'autorisation sont actuellement disponibles :
32 32  
33 33  * (((
34 -**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
25 +**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
35 35  )))
36 36  * (((
37 37  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -44,11 +44,6 @@
44 44  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
45 45  )))
46 46  
47 -(% class="box infomessage" %)
48 -(((
49 -ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
50 -)))
51 -
52 52  == Authentification via BasicAuth ==
53 53  
54 54  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
... ... @@ -60,7 +60,7 @@
60 60  Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
61 61  
62 62  1. Allez dans la section **Authentication**.
63 -1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
49 +1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
64 64  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.
65 65  1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
66 66  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é**.
... ... @@ -69,13 +69,6 @@
69 69  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
70 70  Par exemple :
71 71  [[image:Requête_jwt.png||alt="Requête JWT"]]
72 -
73 -(% class="box warningmessage" %)
74 -(((
75 -❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
76 -)))
77 -
78 -(% start="5" %)
79 79  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
80 80  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
81 81  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
... ... @@ -85,95 +85,29 @@
85 85  
86 86  Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
87 87  
88 -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 :
67 +Pour des raisons de sécurité, il est recommandé d'utiliser votre propre clé privée via des variables d'environnement :
89 89  
90 -* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
91 -* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
69 +DD_JWT_SECRETKEY: can be set to a custom password to use it when signing JWTs
70 +DD_JWT_SECRETKEY_PATH: can be set to specify the path of an RSA private key to use when signing JWTs
92 92  
93 -À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
72 +DD_JWT_SECRETKEY_PATH has priority over DD_JWT_SECRETKEY. If neither are set, a hardcoded secret is used instead and a warning message can be found in the logs saying that this is considered insecure and should be changed.
94 94  
95 -La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
74 +The RSA private key can be generated using the following command (requires openssl):
96 96  
97 -{{code language="shell"}}
98 -openssl -genrsa -out /path/to/privatekey.pem 2048
99 -{{/code}}
76 +{{{openssl -genrsa -out /path/to/privatekey.pem 2048
77 +}}}
100 100  
101 -La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
102 102  
103 -{{code language="shell"}}
104 -openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
105 -{{/code}}
80 +The RSA public key can be optionally be generated from the private key using the following command:
106 106  
82 +{{{openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt}}}
83 +
107 107  == Authentification via BearerAuth ==
108 108  
109 -(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
110 -(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
86 +== (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :(%%) ==
111 111  
112 112  1. Cliquez sur le bouton **Authorize**.
113 -1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
114 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
89 +1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
115 115  1. Cliquez sur **Authorize**.
116 116  
117 -= API disponibles =
118 -
119 -== Liste des API ==
120 -
121 -Les API disponibles sont classées par type :
122 -
123 -* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
124 -* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
125 -* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
126 -* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
127 -* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
128 -
129 -(% class="box infomessage" %)
130 -(((
131 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
132 -)))
133 -
134 -== Opérations disponibles ==
135 -
136 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
137 -
138 -* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
139 -* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
140 -* (% 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.
141 -* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
142 -* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
143 -
144 -== Envoi de requêtes ==
145 -
146 -(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
147 -(% 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 :
148 -
149 -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é.
150 -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.
151 -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) .
152 -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.
153 -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.**(%%)
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" %)La requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
155 -
156 -(% class="wikigeneratedid" id="HParamE8tres" %)
157 -**Paramètres**
158 -
159 -(% style="width:785px" %)
160 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
161 -|(% 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.
162 -|(% 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.
163 -|(% 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.
164 -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.
165 -|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
166 -|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
167 -Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
168 -
169 169  
170 -
171 -= Expiration et révocation de l'authentification =
172 -
173 -(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
174 -(% 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" %)Lorsque le jeton d'accès expire, vous recevez une réponse (% style="font-size: 10pt; font-variant: normal; white-space: pre-wrap; font-family: ~"Roboto Mono~", monospace; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)401:(%%) "Unauthorized".
175 -
176 -(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
177 -(% 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" %)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 :
178 -
179 -