Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 20.1
edited by Aurelie Bertrand
on 2024/08/29 15:37
Change comment: There is no comment for this version
To version 31.1
edited by Aurelie Bertrand
on 2024/08/29 17:04
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -39,6 +39,11 @@
39 39  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
40 40  )))
41 41  
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 +
42 42  == Authentification via BasicAuth ==
43 43  
44 44  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
... ... @@ -59,6 +59,13 @@
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"]]
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" %)
62 62  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
63 63  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
64 64  [[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
... ... @@ -111,7 +111,7 @@
111 111  
112 112  (% class="box infomessage" %)
113 113  (((
114 -ℹ Le cadenas fermé signifie que vous avez les droits sur l'API.
126 +ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
115 115  )))
116 116  
117 117  == Opérations disponibles ==
... ... @@ -124,7 +124,30 @@
124 124  * (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
125 125  * (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
126 126  
127 -== Envoi d'une requête ==
139 +== Envoi de requêtes ==
128 128  
141 +(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
142 +(% 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 :
129 129  
144 +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é.
145 +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.
146 +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) .
147 +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.
148 +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.**(%%)
149 +➡ (% 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.
150 +
151 +=== Paramètres ===
152 +
153 +(% style="width:785px" %)
154 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
155 +|(% 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.
156 +|(% 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.
157 +|(% 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.
158 +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.
159 +|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
160 +|(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
161 +Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
162 +
130 130  
164 +
165 += Expiration et révocation de l'accès =