Changes for page DigDash API REST

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

Summary

Details

Page properties
Content
... ... @@ -1,0 +1,92 @@
1 += Ouvrir Swagger UI =
2 +
3 +Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 +Cette interface fournit également une documentation visuelle facilitant leur utilisation.
5 +
6 +Pour ouvrir Swagger UI, utilisez le lien suivant :
7 +[[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
8 +dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
9 +
10 +Par exemple:
11 +[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
12 +
13 +Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
14 +
15 += S'authentifier =
16 +
17 +Afin de pouvoir interagir avec les API, vous devez vous authentifier.
18 +
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 +
22 +Deux méthodes d'autorisation sont actuellement disponibles :
23 +
24 +* (((
25 +**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 +)))
27 +* (((
28 +**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
29 +)))
30 +
31 +La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité et utiliser la seconde méthode d'authentification.
32 +
33 +(% class="box warningmessage" %)
34 +(((
35 +❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36 +)))
37 +
38 +== Authentification via BasicAuth ==
39 +
40 +1. Entrez votre nom d'utilisateur et mot de passe Digdash.
41 +1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
42 +➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
43 +
44 +== Création du jeton de sécurité ==
45 +
46 +Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
47 +
48 +1. Allez dans la section **Authentication**.
49 +1. Cliquez sur **POST ddenterpriseapi/api/v1/auth/jwt.**
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é**.
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 +
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 +
Requête_jwt.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +7.6 KB
Content
Réponse_requête_JWT.png
Author
... ... @@ -1,0 +1,1 @@
1 +xwiki:XWiki.aureliebertranddigdashbiz
Size
... ... @@ -1,0 +1,1 @@
1 +46.9 KB
Content