Changes for page DigDash API REST

Summary

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

Details

Page properties

Content

...	...	@@ -1,4 +1,4 @@
1		-= Accéder à Swagger UI =
	1	+= Ouvrir Swagger UI =
2	2
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.
...	...	@@ -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 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.
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.
...	...	@@ -64,53 +64,29 @@
64	64
65	65	Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
66	66
67		-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 :
68	68
69		-* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
70		-* **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
71	71
72		-À 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.
73	73
74		-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):
75	75
76		-{{code language="shell"}}
77		-openssl -genrsa -out /path/to/privatekey.pem 2048
78		-{{/code}}
	76	+{{{openssl -genrsa -out /path/to/privatekey.pem 2048
	77	+}}}
79	79
80		-La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
81	81
82		-{{code language="shell"}}
83		-openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
84		-{{/code}}
	80	+The RSA public key can be optionally be generated from the private key using the following command:
85	85
	82	+{{{openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt}}}
	83	+
86	86	== Authentification via BearerAuth ==
87	87
88		-(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
89		-(% 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 :(%%) ==
90	90
91	91	1. Cliquez sur le bouton **Authorize**.
92		-1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
93		-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.
94	94	1. Cliquez sur **Authorize**.
95	95
96		-= API disponibles =
97		-
98		-Les API disponibles sont classées par type :
99		-
100		-* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
101		-* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
102		-* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
103		-* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
104		-* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
105		-
106		-== Opérations disponibles ==
107		-
108		-Il existe plusieurs types d'opérations pouvant être effectuées via les API :
109		-
110		-* (% style="color:#3498db" %)**GET**(%%) : permet d'obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
111		-* (% style="color:#2ecc71" %)**POST**(%%) : permet de créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
112		-* (% style="color:#16a085" %)**PATCH**(%%)** **: permet de mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
113		-* (% style="color:#e67e22" %)**PUT**(%%)** **: permet de remplacer des éléments (écrase toutes les données et les remplace).
114		-* (% style="color:#c0392b" %)**DELETE**(%%) : supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
115		-
116	116