Changes for page DigDash API REST

Summary

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

Details

Page properties

Content

...	...	@@ -1,5 +1,9 @@
1		-= Ouvrir Swagger UI =
	1	+{{ddtoc/}}
2	2
	3	+----
	4	+
	5	+= Accéder à Swagger UI =
	6	+
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.
5	5
...	...	@@ -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 permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
	29	+**BasicAuth **: La méthode Basic Authentification qui 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.
...	...	@@ -35,6 +35,11 @@
35	35	❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36	36	)))
37	37
	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	+
38	38	== Authentification via BasicAuth ==
39	39
40	40	1. Entrez votre nom d'utilisateur et mot de passe Digdash.
...	...	@@ -54,17 +54,80 @@
54	54	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]].
55	55	1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
56	56	Par exemple :
57		- [[image:Requête_jwt.png||alt="Requête JWT"]]
	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" %)
58	58	1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
59	59	➡ La réponse s'affiche dans la section **Server response** en-dessous.
60	60	[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61	61	1. Copiez le jeton JWT.
62	62
63		-Vous pouvez alors vous authentifier via la seconde méthode :
	79	+=== Signature du jeton de sécurité ===
64	64
	81	+Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
	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 :
	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	+
65	65	1. Cliquez sur le bouton **Authorize**.
66		-1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton.
	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**.
67	67	1. Cliquez sur **Authorize**.
68	68
	112	+= API disponibles =
69	69
	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	+
70	70