Changes for page DigDash API REST

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

From 78.2 to 79.1 From 95.1 to 95.2

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 95.1

edited by Aurelie Bertrand
on 2025/04/29 16:16

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 1 added, 0 removed)
- 1745932166616-318.png

Details

Page properties

Content

@@ -39,7 +39,7 @@
  * (% 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é.)(%%)
  ➡ (% 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.
--Deux méthodes d'autorisation sont actuellement disponibles :
++Trois méthodes d'autorisation sont disponibles :
  * (((
  **BasicAuth **: La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
@@ -68,9 +68,14 @@
 . 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é.
++Vous pouvez à présent créer un jeton JWT ou un clé API pour vous connecter.
--== Créer un jeton de sécurité ==
++== S'authentifier via BearerAuth ==
++Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
++
++=== Créer un jeton de sécurité ===
++
  Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
 . Allez dans la section **Authentication**.
@@ -94,8 +94,10 @@
  ➡ La réponse s'affiche dans la section **Server response** en-dessous.
  [[image:DigDash_API_token_creation_response_FR.png||alt="Réponse serveur"]]
 . Copiez le jeton JWT.
++
--=== Signature du jeton de sécurité ===
++(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
++**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.
@@ -118,8 +118,22 @@
  openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
  {{/code}}
--== Créer une clé API ==
++=== S'authentifier ===
++Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
++
++1. Cliquez sur le bouton **Authorize**.
++1. Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
++1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
++1. Cliquez sur **Authorize**.
++
++== S'authentifier via ApiKeyAuth ==
++
++
++Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
++
++=== Créer une clé API ===
++
  Nous allons créer ici une clé API :
 . Allez dans la section **Authentication**.
@@ -144,14 +144,17 @@
  [[image:1745928288556-250.png||alt="Réponse serveur"]]
 . Copiez la clé API.
--== S'authentifier via BearerAuth ==
++(% class="wikigeneratedid" %)
++La clé API est stockée côté serveur dans un fichier csv //apikeys.csv, //situé par défaut dans le répertoire //appdata/EnterpriseServer/ddenterpriseapi/config. //Vous pouvez modifier le répertoire, ou spécifier les répertoires dans le cas de plusieurs domaines, dans le fichier //digdash.properties// en les ajoutant sous la forme suivante //: ddenterprise.api_keys_path=/chemin/vers/fichier.csv.//
++La clé est hashée et ne peut donc être récupérée.
--(% 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 :
++=== S'authentifier ===
++Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
++
 . Cliquez sur le bouton **Authorize**.
 . Dans la section **BasicAuth**, déconnectez-vous en cliquant sur le bouton **Logout**.
--1. Dans la section **BearerAuth**, collez le jeton JWT dans le champ **Value**.
++1. Dans la section **ApiKeyAuth**, collez la clé API dans le champ Value.
 . Cliquez sur **Authorize**.
  = Ressources API disponibles{{id name="ressources"/}} =
@@ -208,27 +208,53 @@
  (% class="wikigeneratedid" id="HParamE8tres" %)
  **Paramètres**
--(% style="width:785px" %)
--|(% 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.
++(% style="width:1391px" %)
++|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**User management**
++|(% style="width:173px" %)includes|(% style="width:1214px" %)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:1214px" %)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
++|(% style="width:173px" %)resolveProfiles|(% style="width:1214px" %)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" %)
--|(% 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.
++|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Session management**
++|(% style="width:173px" %)users|(% style="width:1214px" %)Vous pouvez spécifier des utilisateurs pour la requête : cliquez sur le bouton **Add string item** et entrez le nom d'un utilisateur. Répétez l'opération si besoin avec les autres utilisateurs.
++|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**Connection management**
++|(% style="width:173px" %)itemRole|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données resteintes aux rôles spécifiés ici.
++|(% style="width:173px" %)nameFilter|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données dont le nom contient la chaîne texte spécifiée ici.
++|(% style="width:173px" %)typeFilter|(% style="width:1214px" %)Vous pouvez restreindre la requête aux connexions de bases de données du ou des type(s) spécifiés ici.
++|(% style="width:173px" %)id (obligatoire)|(% style="width:1214px" %)Spécifiez l'identifiant de la connexion de base de données.
++|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)**License management**
++|(% style="width:173px" %)pattern|(% style="width:1214px" %)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 =
  (% 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" %)Lorsque le jeton de sécurité (JWT) ou la clé API 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="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 le bouton **Logout** en dessous de** BearerAuth **ou **ApiKeyAuth**.
 . 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"]].
++1. Générez un nouveau jeton d'accès ou une nouvelle clé API comme décrit dans le paragraphe [[S'authentifier>>doc:||anchor="Auth"]].
++
++= Invalider un jeton JWT ou une clé API =
++
++== Invalider un jeton JWT ==
++
++Pour un jeton JWT, l'invalidation se fait de manière globale seulement en changeant la clé privée utilisée pour signer et la clé publique associée utilisée pour valider les signatures.
++
++== Invalider une clé API ==
++
++Pour une clé API, l'invalidation se fait de manière individuelle et globale.
++
++Pour invalider une ou plusieurs clés :
++
++(% start="1" %)
++1. Vous pouvez tout d'abord récupérer la liste des clés API ave leur identifiant en utilisant **GET /api/v1/auth/apikeys**. Vous obtenez la liste sous la forme suivante :
++[[image:1745932166616-318.png||alt="Liste clés API"]]
++
++1. Utilisez ensuite **DELETE /api/v1/auth/apikeys **: entrez l'identifiant de la clé API à invalider ou, dans le cas de plusieurs clés, les identifiants séparés par des virgules.
++
++Pour invalider toutes les clés API, supprimez toutes les clés comme ci-dessus ou supprimer le fichier csv //apikeys.csv //contenant les clés avec le serveur éteint.
++
++
++

1745932166616-318.png

Author

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

Size

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

Content

Changes for page DigDash API REST

Summary

Details

Sommaire