Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 26.1
edited by Aurelie Bertrand
on 2024/08/29 16:01
Change comment: There is no comment for this version
To version 7.1
edited by Aurelie Bertrand
on 2024/08/29 11:45
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  
... ... @@ -26,7 +26,7 @@
26 26  Deux méthodes d'autorisation sont actuellement disponibles :
27 27  
28 28  * (((
29 -**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.
30 30  )))
31 31  * (((
32 32  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -39,11 +39,6 @@
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 -(% class="box infomessage" %)
43 -(((
44 -ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
45 -)))
46 -
47 47  == Authentification via BasicAuth ==
48 48  
49 49  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
... ... @@ -64,87 +64,21 @@
64 64  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
65 65  Par exemple :
66 66  [[image:Requête_jwt.png||alt="Requête JWT"]]
67 -
68 -(% class="box warningmessage" %)
69 -(((
70 -❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
71 -)))
72 -
73 -(% start="5" %)
74 74  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
75 75  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
76 76  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
77 77  1. Copiez le jeton JWT.
78 78  
79 -=== Signature du jeton de sécurité ===
63 +== Authentification via BasicAuth ==
80 80  
81 -Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
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é.
82 82  
83 -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 :
69 +Vous pouvez alors vous authentifier via la seconde méthode :
84 84  
85 -* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
86 -* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
87 -
88 -À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
89 -
90 -La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
91 -
92 -{{code language="shell"}}
93 -openssl -genrsa -out /path/to/privatekey.pem 2048
94 -{{/code}}
95 -
96 -La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
97 -
98 -{{code language="shell"}}
99 -openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
100 -{{/code}}
101 -
102 -== Authentification via BearerAuth ==
103 -
104 -(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
105 -(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
106 -
107 107  1. Cliquez sur le bouton **Authorize**.
108 -1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
109 -1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
72 +1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton.
110 110  1. Cliquez sur **Authorize**.
111 111  
112 -= API disponibles =
113 -
114 -== Liste des API ==
115 -
116 -Les API disponibles sont classées par type :
117 -
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.
123 -
124 -(% class="box infomessage" %)
125 -(((
126 -ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
127 -)))
128 -
129 -== Opérations disponibles ==
130 -
131 -Il existe plusieurs types d'opérations pouvant être effectuées via les API :
132 -
133 -* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
134 -* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
135 -* (% 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.
136 -* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
137 -* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
138 -
139 -== Envoi de requêtes ==
140 -
141 -(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
142 -(% 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 vous y êtes autorisé, vous pouvez effectuer des requêtes :
143 -
144 -1. (% 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" %)Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé
145 -1. (% 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" %)Dans la fenêtre de méthode développée, cliquez sur Essayer(Essayer) .
146 -1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire.
147 -
148 -(% 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" %)Cliquez sur Exécuter. La requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
149 -
150 150