Changes for page DigDash API REST

Summary

• Page properties (1 modified, 0 added, 0 removed)

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.
...	...	@@ -59,13 +59,6 @@
59	59	1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
60	60	Par exemple :
61	61	[[image:Requête_jwt.png||alt="Requête JWT"]]
62		-
63		-(% class="box warningmessage" %)
64		-(((
65		-❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
66		-)))
67		-
68		-(% start="5" %)
69	69	1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
70	70	➡ La réponse s'affiche dans la section **Server response** en-dessous.
71	71	[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
...	...	@@ -75,63 +75,29 @@
75	75
76	76	Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
77	77
78		-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 :
79	79
80		-* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
81		-* **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
82	82
83		-À 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.
84	84
85		-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):
86	86
87		-{{code language="shell"}}
88		-openssl -genrsa -out /path/to/privatekey.pem 2048
89		-{{/code}}
	76	+{{{openssl -genrsa -out /path/to/privatekey.pem 2048
	77	+}}}
90	90
91		-La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
92	92
93		-{{code language="shell"}}
94		-openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
95		-{{/code}}
	80	+The RSA public key can be optionally be generated from the private key using the following command:
96	96
	82	+{{{openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt}}}
	83	+
97	97	== Authentification via BearerAuth ==
98	98
99		-(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
100		-(% 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 :(%%) ==
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**.
104		-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.
105	105	1. Cliquez sur **Authorize**.
106	106
107		-= API disponibles =
108		-
109		-== Liste des API ==
110		-
111		-Les API disponibles sont classées par type :
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.
118		-
119		-(% class="box infomessage" %)
120		-(((
121		-ℹ Le cadenas fermé signifie que vous avez les droits sur l'API.
122		-)))
123		-
124		-== Opérations disponibles ==
125		-
126		-Il existe plusieurs types d'opérations pouvant être effectuées via les API :
127		-
128		-* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
129		-* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
130		-* (% 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.
131		-* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
132		-* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
133		-
134		-== Envoi d'une requête ==
135		-
136		-
137	137