Changes for page DigDash API REST

Last modified by Aurelie Bertrand on 2025/05/15 16:29

From 35.1 to 34.1 From 80.1 to 79.1

From version 79.1

edited by Aurelie Bertrand
on 2025/04/29 14:06

Change comment: There is no comment for this version

To version 35.1

edited by Aurelie Bertrand
on 2024/08/30 08:52

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (3 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 9 removed)

Details

Page properties

Title

@@ -1,1 +1,1 @@
--DigDash API REST
++Digdash API

Parent

...	...	@@ -1,1 +1,0 @@
1		-Digdash.API.WebHome

Content

@@ -2,27 +2,19 @@
  ----
--(% class="wikigeneratedid" %)
--DigDash propose une API REST pour interagir avec un certain nombre d'objets DigDash.
--Vous pouvez utiliser Swagger pour la tester.
--
  = Accéder à Swagger UI =
  Swagger UI permet de visualiser et d'interagir avec les ressources des API.
  Cette interface fournit également une documentation visuelle facilitant leur utilisation.
--Pour ouvrir Swagger UI, vous pouvez :
--
--* cliquer sur le lien **API** présent en bas de la page d'accueil
--
--* utiliser le lien suivant :(((
++Pour ouvrir Swagger UI, utilisez le lien suivant :
  [[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
  dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
++
  Par exemple:
--[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
--)))
++[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
--Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
++Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
  (% class="box infomessage" %)
  (((
@@ -29,11 +29,8 @@
  💡 Dans le cas où le nom de domaine a été modifié, il est possible de spécifier un domaine ddapi personnalisé dans le champ **domain**.
  )))
--(% class="wikigeneratedid" %)
--[[image:DigDash_API.png||alt="Interface Swagger" height="770" width="1043"]]
++= S'authentifier =
--= S'authentifier{{id name="Auth"/}} =
--
  Afin de pouvoir interagir avec les API, vous devez vous authentifier.
  * (% 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é.)(%%)
@@ -45,13 +45,10 @@
  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
  )))
  * (((
--**BearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
++**bearerAuth** : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
  )))
--* (((
--**ApiKeyAuth** : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
--)))
--La méthode BasicAuth sera utilisée pour la première authentification. Vous pourrez alors générer un jeton de sécurité ou une clé API et utiliser l'une des deux autres méthodes.
++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.
  (% class="box warningmessage" %)
  (((
@@ -63,15 +63,15 @@
  ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
  )))
--== S'authentifier via BasicAuth ==
++== Authentification via BasicAuth ==
 . Entrez votre nom d'utilisateur et mot de passe Digdash.
 . Cliquez sur le bouton **Authorize** puis, une fois l'authentification effectuée, sur **Close**.
  ➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
--== Créer un jeton de sécurité ==
++== Création du jeton de sécurité ==
--Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
++Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
 . Allez dans la section **Authentication**.
 . Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/jwt.**
@@ -82,24 +82,24 @@
 *. **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]].
 *. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
  Par exemple :
--[[image:DigDash_API_token_creation_FR.png||alt="Exemple authentification"]]
++[[image:Requête_jwt.png||alt="Requête JWT"]]
  (% class="box warningmessage" %)
  (((
--❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
++❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
  )))
  (% start="5" %)
 . Cliquez sur le bouton **Execute **pour générer le jeton (JWT).
  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
--[[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
++[[image:Réponse_requête_JWT.png||alt="Réponse requête JWT"]]
 . Copiez le jeton JWT.
  === Signature du jeton de sécurité ===
--Une clé privée utilisée pour signer le JWT est générée par défaut. Cette clé est temporaire et est régénérée à chaque redémarrage du serveur.
++Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
--Pour éviter ce problème et améliorer la 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 :
++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 :
  * **DD_JWT_SECRETKEY_PATH**: cette variable permet de définir le chemin vers une clé privée RSA.
  * **DD_JWT_SECRETKEY**: cette variable permet de définir un mot de passe personnalisé.
@@ -109,7 +109,7 @@
  La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
  {{code language="shell"}}
--openssl genrsa -out /path/to/privatekey.pem 2048
++openssl -genrsa -out /path/to/privatekey.pem 2048
  {{/code}}
  La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
@@ -118,64 +118,36 @@
  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
  {{/code}}
--== Créer une clé API ==
++== Authentification via BearerAuth ==
--Nous allons créer ici une clé API :
--
--1. Allez dans la section **Authentication**.
--1. Cliquez pour déplier **POST ddenterpriseapi/api/v1/auth/apikeys**
--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.
--1. Cliquez sur **Try it out **en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
--1*. **targetUser** : (Optionnel) Indiquez le nom de l'utilisateur à emprunter. Cela ne fonctionne que si l'utilisateur utilisé pour créer la clé API dispose de l'autorisation (ACL) **Admin > Autoriser l'emprunt d'identité**.
--S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
--1*. **expires** : (Optionnel) Indiquez la période de validité la clé API 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]].
--1*. **permissions **: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
--Par exemple :
--[[image:1745928168043-553.png]]
--
--(% class="box warningmessage" %)
--(((
--❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
--)))
--
--(% start="5" %)
--1. Cliquez sur le bouton **Execute **pour générer la clé API.
--➡ La réponse s'affiche dans la section **Server response** en-dessous.
--[[image:1745928288556-250.png||alt="Réponse serveur"]]
--1. Copiez la clé API.
--
--== S'authentifier via BearerAuth ==
--
  (% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
  (% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
 . Cliquez sur le bouton **Authorize**.
--1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
++1. Dans la section **BasiAuthc**, déconnectez-vous en cliquant sur le bouton **Logout**.
 . Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
 . Cliquez sur **Authorize**.
--= Ressources API disponibles{{id name="ressources"/}} =
++= API disponibles =
--== Liste des ressources ==
++== Liste des API ==
--Les ressources disponibles sont classées par type :
++Les API disponibles sont classées par type :
--* **Authentification **: pour la création des jetons de sécurité (JWT)
--* **User Management** : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autosations des rôles, etc.
--* **Session Management **: pour l'obtention de la liste des sessions, la supression de sessions.
--* **System** : pour les informations système, service d'audit et ordonnanceur.
--* **License Management** : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
--* **Event Management** : pour l'ajout d'évènements avec fireEvent.
--* **Connections **: pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
++* **Authentification **: contient l'API permettant, comme vu précédemment,  la création des jetons de sécurité (JWT)
++* **User Management** : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
++* **System** : contient les API liées aux informations système, service d'audit et ordonnanceur.
++* **License Management** : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
++* **Event Management** : contient l'API permattant d'ajouter un évènement avec fireEvent.
  (% class="box infomessage" %)
  (((
--ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
++ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
  )))
  == Opérations disponibles ==
--Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
++Il existe plusieurs types d'opérations pouvant être effectuées via les API :
  * (% style="color:#3498db" %)**GET**(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
  * (% style="color:#2ecc71" %)**POST**(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
@@ -185,26 +185,16 @@
  == Envoi de requêtes ==
--(% class="box warningmessage" %)
--(((
--❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
--)))
--
  (% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
  (% 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" %)Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes :
--1. (% 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" %)Développez une ressource avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
++1. (% 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" %)Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
 . 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.
 . (% 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" %)Dans la fenêtre de méthode développée, cliquez sur **Try it out **(Essayer) .
--1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée dans le tableau ci-dessous.
++1. (% 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" %)Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée ci-dessous.
 . (% 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 **Execute.**(%%)
--➡ (% 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 requête est exécutée et la réponse s'affiche.
--Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
++➡ (% 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 requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
--(% id="cke_bm_11947S" style="display:none" %) (%%)Swagger propose également des lignes de commande curl lors de l'exécution des requêtes afin d'aider à tester ou coder un outil en dehors du navigateur (dans un script par exemple).
--À noter qu'il faut spécifier, que soit pour curl ou un autre outil, les entêtes HTTP "Accept" (format du contenu à récupérer) et "Content-Type" (format du contenu envoyé) pour que les requêtes fonctionnent correctement. Ces deux entêtes peuvent prendre les valeurs "application/json" pour du json ou "application/xml" pour du xml.
--[[image:1725441504464-493.png]]
--
  (% class="wikigeneratedid" id="HParamE8tres" %)
  **Paramètres**
@@ -212,23 +212,20 @@
  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**User management**
  |(% style="width:173px" %)includes|(% style="width:608px" %)Vous pouvez ajouter les rôles, autorisations (acls) et/ou groupes d'autorisations (groupacls) au résultat de la requête.
  |(% style="width:173px" %)id (obligatoire)|(% style="width:608px" %)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
--|(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seront affichées.
--Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seront affichés et non pas les rôles propres à l'utilisateur.
--|(% style="width:173px" %) |(% style="width:608px" %)
--|(% style="width:173px" %) |(% style="width:608px" %)
--|(% style="width:173px" %) |(% style="width:608px" %)
--|(% style="width:173px" %) |(% style="width:608px" %)
++|(% style="width:173px" %)resolveProfiles|(% style="width:608px" %)Si défini à //true//, si l'utilisateur a un profil, ce sont les informations du profil qui seraont affichées.
++Par exemple, si l'utilisateur a des rôles issus d'un profil, ce sont les rôles du profil qui seont affichés et non pas les rôles propres à l'utilisateur.
  |(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)**License management**
  |(% style="width:173px" %)pattern|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
  Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
--= Expiration de l'authentification =
++
++= Expiration et révocation de l'authentification =
++
  (% style="line-height:1.7142857142857142; background-color:#ffffff" %)
--(% 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" %)Lorsque le jeton de sécurité (JWT) expire, vous recevez une réponse (% style="color:#182027; font-family:~"Roboto Mono~",monospace; font-size:10pt; font-style:normal; font-variant:normal; font-weight:400; text-decoration:none; white-space:pre-wrap" %)401:(%%) "Unauthorized".
--(% 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" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton a expiré. Lorsque cela se produit, vous devez vous déconnecter de (%%)BearerAuth** **(% 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" %)et générer un nouveau jeton d'accès.
++(% 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" %)Lorsque le jeton d'accès expire, vous recevez une réponse (% style="font-size: 10pt; font-variant: normal; white-space: pre-wrap; font-family: ~"Roboto Mono~", monospace; color: rgb(24, 32, 39); font-weight: 400; font-style: normal; text-decoration: none" %)401:(%%) "Unauthorized".
--1. (% 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** pour ouvrir la fenêtre **Available authorizations**.
--1. Cliquez sur le bouton **Logout** en dessous de** BearerAuth**.
--1. Cliquez sur** Close** pour **Fermer**.
--1. Générez un nouveau jeton d'accès comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
++(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
++(% 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" %)L'en-tête d'autorisation du porteur est toujours présent pour vos demandes, mais le jeton d'accès a expiré. Lorsque cela se produit, vous devez invalider le jeton expiré et générer un nouveau jeton d'accès :
++
++

1725441504464-493.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-25.3 KB

Content

1745927162186-776.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-8.7 KB

Content

1745928144436-696.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-8.4 KB

Content

1745928168043-553.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-8.1 KB

Content

1745928288556-250.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-43.6 KB

Content

DD_API.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-63.1 KB

Content

DigDash_API.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-86.5 KB

Content

DigDash_API_token_creation_FR.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-13.6 KB

Content

DigDash_API_token_creation_response_FR.png

Author

...	...	@@ -1,1 +1,0 @@
1		-xwiki:XWiki.aureliebertranddigdashbiz

Size

...	...	@@ -1,1 +1,0 @@
1		-58.4 KB

Content

Changes for page DigDash API REST

Summary

Details

Sommaire