Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 4.1
edited by Aurelie Bertrand
on 2024/08/29 10:06
Change comment: There is no comment for this version
To version 21.1
edited by Aurelie Bertrand
on 2024/08/29 15:42
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,5 +1,9 @@
1 -= Ouvrir Swagger UI =
1 +{{ddtoc/}}
2 2  
3 +----
4 +
5 += Accéder à Swagger UI =
6 +
3 3  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
4 4  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
5 5  
... ... @@ -22,7 +22,7 @@
22 22  Deux méthodes d'autorisation sont actuellement disponibles :
23 23  
24 24  * (((
25 -**BasicAuth **: La méthode Basic Authentification permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
29 +**BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
26 26  )))
27 27  * (((
28 28  **bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
... ... @@ -48,14 +48,86 @@
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. (((
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é**.
55 +1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
56 +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.
58 +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]].
59 +1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
60 +Par exemple :
61 +[[image:Requête_jwt.png||alt="Requête JWT"]]
54 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.
63 +(% class="box warningmessage" %)
64 +(((
65 +❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
58 58  )))
67 +
68 +(% start="5" %)
69 +1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
70 +➡ La réponse s'affiche dans la section **Server response** en-dessous.
71 +[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
72 +1. Copiez le jeton JWT.
73 +
74 +=== Signature du jeton de sécurité ===
75 +
76 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
77 +
78 +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 :
79 +
80 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
81 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
82 +
83 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
84 +
85 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
86 +
87 +{{code language="shell"}}
88 +openssl -genrsa -out /path/to/privatekey.pem 2048
89 +{{/code}}
90 +
91 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
92 +
93 +{{code language="shell"}}
94 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
95 +{{/code}}
96 +
97 +== Authentification via BearerAuth ==
98 +
99 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
100 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
101 +
102 +1. Cliquez sur le bouton **Authorize**.
103 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
104 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
105 +1. Cliquez sur **Authorize**.
106 +
107 += API disponibles =
108 +
109 +== Liste des API ==
110 +
111 +Les API disponibles sont classées par type :
112 +
113 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
114 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
115 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
116 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
117 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
118 +
119 +(% class="box infomessage" %)
120 +(((
121 +ℹ Le cadenas fermé signifie que vous avez les droits sur l'API.
59 59  )))
60 60  
124 +== Opérations disponibles ==
125 +
126 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
127 +
128 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
129 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
130 +* (% style="color:#16a085" %)**PATCH**(%%)** **: pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
131 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
132 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
133 +
134 +== Envoi d'une requête ==
135 +
136 +
61 61  
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