Changes for page DigDash API REST

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

Summary

Details

Page properties
Content
... ... @@ -52,41 +52,7 @@
52 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é**.
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 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.
55 +1*. **permissions **: Définissez les autorisations à donner à ce jeton : "-" pour aucune autorisation, "r" pour lecture seule, "rw" pour lecture-écriture.
56 +1.
62 62  
63 -=== Signature du jeton de sécurité ===
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 recommandé d'utiliser votre propre clé privée via des variables d'environnement :
68 -
69 -DD_JWT_SECRETKEY: can be set to a custom password to use it when signing JWTs
70 -DD_JWT_SECRETKEY_PATH: can be set to specify the path of an RSA private key to use when signing JWTs
71 -
72 -DD_JWT_SECRETKEY_PATH has priority over DD_JWT_SECRETKEY. If neither are set, a hardcoded secret is used instead and a warning message can be found in the logs saying that this is considered insecure and should be changed.
73 -
74 -The RSA private key can be generated using the following command (requires openssl):
75 -
76 -{{{openssl -genrsa -out /path/to/privatekey.pem 2048
77 -}}}
78 -
79 -
80 -The RSA public key can be optionally be generated from the private key using the following command:
81 -
82 -{{{openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt}}}
83 -
84 -== Authentification via BearerAuth ==
85 -
86 -== (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :(%%) ==
87 -
88 -1. Cliquez sur le bouton **Authorize**.
89 -1. Dans le champ **Value** de bearerAuth  (http, Bearer), collez le jeton JWT.
90 -1. Cliquez sur **Authorize**.
91 -
92 92  
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