Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/03/25 16:13
From version 2.1
edited by Aurelie Bertrand
on 2024/08/29 09:57
Change comment: There is no comment for this version
To version 19.1
edited by Aurelie Bertrand
on 2024/08/29 15:27
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -1,10 +1,14 @@
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  
6 6  Pour ouvrir Swagger UI, utilisez le lien suivant :
7 - [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
11 +[[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,13 +16,13 @@
16 16  
17 17  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
18 18  
19 -* (% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Cliquez sur le bouton (%%)**Authorize**(% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %) en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)(%%)
20 -➡ (% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)La fenêtre (%%)**Available authorizations** ((% style="font-size: 10.5pt; font-variant: normal; white-space: pre-wrap; font-family: Arial, sans-serif; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)Autorisations disponibles) s'affiche.
23 +* (% 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é.)(%%)
24 +➡ (% 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  
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.
... ... @@ -35,7 +35,7 @@
35 35  ❗Il n'est pas recommandé d'utiliser la méthode **BasicAuth** de manière systématique pour des raisons de sécurité.
36 36  )))
37 37  
38 -== Authentification via BasicAuth ==
42 +== Authentification via BasicAuth ==
39 39  
40 40  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
41 41  1. Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
... ... @@ -49,7 +49,69 @@
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 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 -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.
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é**.
57 +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"]]
62 +1. Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
63 +➡ La réponse s'affiche dans la section **Server response** en-dessous.
64 +[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
65 +1. Copiez le jeton JWT.
54 54  
55 -
67 +=== Signature du jeton de sécurité ===
68 +
69 +Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
70 +
71 +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 :
72 +
73 +* **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
74 +* **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
75 +
76 +À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
77 +
78 +La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
79 +
80 +{{code language="shell"}}
81 +openssl -genrsa -out /path/to/privatekey.pem 2048
82 +{{/code}}
83 +
84 +La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
85 +
86 +{{code language="shell"}}
87 +openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
88 +{{/code}}
89 +
90 +== Authentification via BearerAuth ==
91 +
92 +(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
93 +(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
94 +
95 +1. Cliquez sur le bouton **Authorize**.
96 +1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
97 +1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
98 +1. Cliquez sur **Authorize**.
99 +
100 += API disponibles =
101 +
102 +== Liste des API ==
103 +
104 +Les API disponibles sont classées par type :
105 +
106 +* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
107 +* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
108 +* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
109 +* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
110 +* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
111 +
112 +== Opérations disponibles ==
113 +
114 +Il existe plusieurs types d'opérations pouvant être effectuées via les API :
115 +
116 +* (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
117 +* (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
118 +* (% 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.
119 +* (% style="color:#e67e22" %)**PUT**(%%)** **: pour remplacer des éléments (écrase toutes les données et les remplace).
120 +* (% style="color:#c0392b" %)**DELETE**(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
121 +
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