Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29
From version 68.1
edited by Aurelie Bertrand
on 2025/03/14 10:14
Change comment: Ajout du fichier DigDash_API_token_creation_response_FR.png
To version 74.1
edited by Aurelie Bertrand
on 2025/04/25 14:24
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -30,7 +30,7 @@
30 30  )))
31 31  
32 32  (% class="wikigeneratedid" %)
33 -[[image:DigDash_API.png||height="770" width="1043"]]
33 +[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
34 34  
35 35  = S'authentifier{{id name="Auth"/}} =
36 36  
... ... @@ -79,7 +79,7 @@
79 79  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]].
80 80  1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
81 81  Par exemple :
82 -[[image:Requête_jwt.png||alt="Requête JWT"]]
82 +[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
83 83  
84 84  (% class="box warningmessage" %)
85 85  (((
... ... @@ -89,7 +89,7 @@
89 89  (% start="5" %)
90 90  1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
91 91  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
92 -[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
92 +[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
93 93  1. Copiez le jeton JWT.
94 94  
95 95  === Signature du jeton de sécurité ===
... ... @@ -106,7 +106,7 @@
106 106  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
107 107  
108 108  {{code language="shell"}}
109 -openssl -genrsa -out /path/to/privatekey.pem 2048
109 +openssl genrsa -out /path/to/privatekey.pem 2048
110 110  {{/code}}
111 111  
112 112  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
... ... @@ -125,7 +125,7 @@
125 125  1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
126 126  1. Cliquez sur **Authorize**.
127 127  
128 -= Ressources API disponibles =
128 += Ressources API disponibles{{id name="ressources"/}} =
129 129  
130 130  == Liste des ressources ==
131 131  
... ... @@ -132,7 +132,7 @@
132 132  Les ressources disponibles sont classées par type :
133 133  
134 134  * **Authentification **: pour la création des jetons de sécurité (JWT)
135 -* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
135 +* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autosations des rôles, etc.
136 136  * **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
137 137  * **System** : pour les informations système, service d'audit et ordonnanceur.
138 138  * **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
... ... @@ -185,6 +185,10 @@
185 185  |(% 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.
186 186  |(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
187 187  Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seront affichés et non pas les rôles propres à l'utilisateur.
188 +|(% style="width:173px" %) |(% style="width:608px" %)
189 +|(% style="width:173px" %) |(% style="width:608px" %)
190 +|(% style="width:173px" %) |(% style="width:608px" %)
191 +|(% style="width:173px" %) |(% style="width:608px" %)
188 188  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
189 189  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
190 190  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.