Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 12.1
edited by Aurelie Bertrand
on 2024/08/29 14:29
Change comment: There is no comment for this version
To version 5.1
edited by Aurelie Bertrand
on 2024/08/29 10:07
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -48,48 +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) 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é**.
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 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 -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]].
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 -Par exemple :
57 -[[image:Requête_jwt.png||alt="Requête JWT"]]
58 -1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
59 -➡ La réponse s'affiche dans la section **Server response** en-dessous.
60 -[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
61 -1. Copiez le jeton JWT.
62 62  
63 -=== Signature du jeton de sécurité ===
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.
58 +)))
59 +)))
64 64  
65 -Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
66 -
67 -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 :
68 -
69 -* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
70 -* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
71 -
72 -À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
73 -
74 -La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
75 -
76 -{{code language="shell"}}
77 -openssl -genrsa -out /path/to/privatekey.pem 2048
78 -{{/code}}
79 -
80 -La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
81 -
82 -{{code language="shell"}}
83 -openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
84 -{{/code}}
85 -
86 -== Authentification via BearerAuth ==
87 -
88 -(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
89 -(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
90 -
91 -1. Cliquez sur le bouton **Authorize**.
92 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
93 -1. Cliquez sur **Authorize**.
94 -
95 95  
Requête_jwt.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -7.6 KB
Content
Réponse_requête_JWT.png
Author
... ... @@ -1,1 +1,0 @@
1 -xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,1 +1,0 @@
1 -46.9 KB
Content