Modifications pour le document DigDash API REST

Résumé

• Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)

Détails

Propriétés de la Page

Contenu

...	...	@@ -16,6 +16,11 @@
16	16
17	17	Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
18	18
	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	+
19	19	= S'authentifier =
20	20
21	21	Afin de pouvoir interagir avec les API, vous devez vous authentifier.
...	...	@@ -55,7 +55,7 @@
55	55	Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
56	56
57	57	1. Allez dans la section **Authentication**.
58		-1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
	63	+1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
59	59	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.
60	60	1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
61	61	1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer le JWT dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
...	...	@@ -138,5 +138,37 @@
138	138
139	139	== Envoi de requêtes ==
140	140
	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 :
141	141
	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	+
142	142
	170	+
	171	+= Expiration et révocation de l'authentification =
	172	+
	173	+(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
	174	+(% 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 le jeton d'accès expire, vous recevez une réponse (% style="font-size: 10pt; font-variant: normal; white-space: pre-wrap; font-family: ~"Roboto Mono~", monospace; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)401:(%%) "Unauthorized".
	175	+
	176	+(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
	177	+(% 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" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :
	178	+
	179	+