Modifications pour le document DigDash API REST
Modifié par Aurelie Bertrand le 2025/03/25 16:13
Depuis la version 2.2
modifié par Aurelie Bertrand
sur 2024/08/29 10:03
sur 2024/08/29 10:03
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
À la version 4.1
modifié par Aurelie Bertrand
sur 2024/08/29 10:06
sur 2024/08/29 10:06
Commentaire de modification :
Il n'y a aucun commentaire pour cette version
Résumé
-
Propriétés de la Page (1 modifications, 0 ajouts, 0 suppressions)
Détails
- Propriétés de la Page
-
- Contenu
-
... ... @@ -4,7 +4,7 @@ 4 4 Cette interface fournit également une documentation visuelle facilitant leur utilisation. 5 5 6 6 Pour ouvrir Swagger UI, utilisez le lien suivant : 7 - 7 +[[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]] 8 8 dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations. 9 9 10 10 Par exemple: ... ... @@ -16,8 +16,8 @@ 16 16 17 17 Afin de pouvoir interagir avec les API, vous devez vous authentifier. 18 18 19 -* (% style=" font-size:.5pt; font-variant: normal; white-space: pre-wrap;font-family:color: rgb(24, 32, 39);font-weight:400; font-style: normal; text-decoration:font-size:.5pt; font-variant: normal; white-space: pre-wrap;font-family:color: rgb(24, 32, 39);font-weight:400; font-style: normal; text-decoration:20 -➡ (% style=" font-size:.5pt; font-variant: normal; white-space: pre-wrap;font-family:color: rgb(24, 32, 39);font-weight:400; font-style: normal; text-decoration:font-size:.5pt; font-variant: normal; white-space: pre-wrap;font-family:color: rgb(24, 32, 39);font-weight:400; font-style: normal; text-decoration:19 +* (% 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 le bouton (%%)**Authorize**(% 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" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%) 20 +➡ (% 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 fenêtre (%%)**Available authorizations** ((% 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" %)Autorisations disponibles) s'affiche. 21 21 22 22 Deux méthodes d'autorisation sont actuellement disponibles : 23 23 ... ... @@ -48,12 +48,14 @@ 48 48 1. Allez dans la section **Authentication**. 49 49 1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.** 50 50 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. 51 -1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants : 52 -1*. **targetUser** : (Optionnel) 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é**. 53 -S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté. 54 -1*. **expires** : (Optionnel mais recommandé) 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 -1*. ((( 56 -**permissions **: Autorisations à donner à ce jeton : "-" pour aucune autorisation, "r" pour lecture seule, "rw" pour lecture-écriture. 51 +1. ((( 52 +Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :* **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é**. 53 +S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas. 54 + 55 +* **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]]. 56 +* ((( 57 +**permissions **: Définissez les autorisations à donner à ce jeton : "-" pour aucune autorisation, "r" pour lecture seule, "rw" pour lecture-écriture. 57 57 ))) 59 +))) 58 58 59 59