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
...	...	@@ -12,6 +12,11 @@
12	12
13	13	Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
14	14
	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	+
15	15	= S'authentifier =
16	16
17	17	Afin de pouvoir interagir avec les API, vous devez vous authentifier.
...	...	@@ -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.
	34	+**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
	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	+
38	38	== Authentification via BasicAuth ==
39	39
40	40	1. Entrez votre nom d'utilisateur et mot de passe Digdash.
...	...	@@ -55,17 +55,103 @@
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	57	[[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" %)
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
	84	+=== Signature du jeton de sécurité ===
	85	+
	86	+Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
	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 :
	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é.
	92	+
	93	+À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
	94	+
	95	+La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
	96	+
	97	+{{code language="shell"}}
	98	+openssl -genrsa -out /path/to/privatekey.pem 2048
	99	+{{/code}}
	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	+
	103	+{{code language="shell"}}
	104	+openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
	105	+{{/code}}
	106	+
63	63	== Authentification via BearerAuth ==
64	64
65		-== (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :(%%) ==
	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 :
66	66
67	67	1. Cliquez sur le bouton **Authorize**.
68		-1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
	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**.
69	69	1. Cliquez sur **Authorize**.
70	70
	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	+
71	71
	170	+
	171	+= Expiration et révocation de l'accès =