Wiki source code of DigDash API REST

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

version	line-number	content
19.1	1	{{ddtoc/}}
	2
	3	----
	4
37.1	5	(% class="wikigeneratedid" %)
	6	DigDash propose une API REST pour interagir avec un certain nombre d'objets DigDash.
	7	Vous pouvez utiliser Swagger pour la tester.
	8
15.1	9	= Accéder à Swagger UI =
1.2	10
	11	Swagger UI permet de visualiser et d'interagir avec les ressources des API.
	12	Cette interface fournit également une documentation visuelle facilitant leur utilisation.
	13
64.2	14	Pour ouvrir Swagger UI, vous pouvez :
	15
66.1	16	* cliquer sur le lien API présent en bas de la page d'accueil
64.2	17
	18	* utiliser le lien suivant :(((
4.1	19	[[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
1.2	20	dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
	21	Par exemple:
53.1	22	[[http:~~/~~/localhost:8080/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
64.2	23	)))
1.2	24
37.1	25	Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.
1.2	26
32.1	27	(% class="box infomessage" %)
	28	(((
	29	💡 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.
	30	)))
	31
37.1	32	(% class="wikigeneratedid" %)
70.1	33	[[image:DigDash_API.png\|\|alt="Interface Swagger" height="770" width="1043"]]
37.1	34
55.1	35	= S'authentifier{{id name="Auth"/}} =
1.2	36
	37	Afin de pouvoir interagir avec les API, vous devez vous authentifier.
	38
4.1	39	* (% 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é.)(%%)
	40	➡ (% 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.
1.2	41
94.1	42	Trois méthodes d'autorisation sont disponibles :
1.2	43
	44	* (((
14.1	45	BasicAuth : La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
1.2	46	)))
	47	* (((
53.1	48	BearerAuth : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
1.2	49	)))
78.2	50	* (((
	51	ApiKeyAuth : La méthode Api Key Authentification qui permet de s'identifier avec une clé API.
	52	)))
1.2	53
78.2	54	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.
1.2	55
	56	(% class="box warningmessage" %)
	57	(((
	58	❗Il n'est pas recommandé d'utiliser la méthode BasicAuth de manière systématique pour des raisons de sécurité.
	59	)))
	60
25.1	61	(% class="box infomessage" %)
	62	(((
	63	ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
	64	)))
	65
42.1	66	== S'authentifier via BasicAuth ==
1.3	67
1.4	68	1. Entrez votre nom d'utilisateur et mot de passe Digdash.
	69	1. Cliquez sur le bouton Authorize puis, une fois l'authentification effectuée, sur Close.
	70	➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
80.1	71	Vous pouvez à présent créer un jeton JWT ou un clé API pour vous connecter.
1.3	72
80.1	73	== S'authentifier via BearerAuth ==
1.3	74
80.1	75	Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
	76
96.1	77	=== Créer un jeton JWT{{id name="JWT"/}} ===
80.1	78
78.2	79	Nous allons créer ici un jeton de sécurité Json Web Token (JWT) :
1.4	80
	81	1. Allez dans la section Authentication.
34.1	82	1. Cliquez pour déplier POST ddenterpriseapi/api/v1/auth/jwt.
1.4	83	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.
5.2	84	1. Cliquez sur Try it out en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
	85	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é.
3.1	86	S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
5.2	87	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]].
5.3	88	1. permissions *: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
5.4	89	Par exemple :
69.1	90	[[image:DigDash_API_token_creation_FR.png\|\|alt="Exemple authentification"]]
21.1	91
	92	(% class="box warningmessage" %)
	93	(((
59.1	94	❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
21.1	95	)))
	96
	97	(% start="5" %)
5.4	98	1. Cliquez sur le bouton Execute pour générer le jeton (JWT).
	99	➡ La réponse s'affiche dans la section Server response en-dessous.
69.1	100	[[image:DigDash_API_token_creation_response_FR.png\|\|alt="Réponse serveur"]]
5.4	101	1. Copiez le jeton JWT.
81.1	102
3.1	103
81.1	104	(% class="wikigeneratedid" id="HSignaturedujetondesE9curitE9" %)
	105	Signature du jeton de sécurité
9.1	106
64.1	107	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.
9.1	108
63.1	109	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 :
9.1	110
10.1	111	* DD_JWT_SECRETKEY_PATH: cette variable permet de définir le chemin vers une clé privée RSA.
	112	* DD_JWT_SECRETKEY: cette variable permet de définir un mot de passe personnalisé.
9.1	113
10.1	114	À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
9.1	115
10.1	116	La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
9.1	117
10.1	118	{{code language="shell"}}
71.1	119	openssl genrsa -out /path/to/privatekey.pem 2048
10.1	120	{{/code}}
9.1	121
10.1	122	La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):
9.1	123
10.1	124	{{code language="shell"}}
	125	openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
	126	{{/code}}
9.1	127
82.1	128	=== S'authentifier ===
	129
	130	Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
	131
	132	1. Cliquez sur le bouton Authorize.
	133	1. Dans la section BasicAuth, déconnectez-vous en cliquant sur le bouton Logout.
	134	1. Dans la section BearerAuth, collez le jeton JWT dans le champ Value.
	135	1. Cliquez sur Authorize.
	136
80.1	137	== S'authentifier via ApiKeyAuth ==
78.2	138
92.1	139	Une fois connecté via BasicAuth, vous pouvez générer un jeton de sécurité pour vous identifier via la méthode BearerAuth.
	140
97.1	141	=== Créer une clé API{{id name="API"/}} ===
80.1	142
78.2	143	Nous allons créer ici une clé API :
	144
	145	1. Allez dans la section Authentication.
	146	1. Cliquez pour déplier POST ddenterpriseapi/api/v1/auth/apikeys
	147	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.
	148	1. Cliquez sur Try it out en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
	149	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é.
	150	S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
	151	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]].
	152	1. permissions *: Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
	153	Par exemple :
	154	[[image:1745928168043-553.png]]
	155
	156	(% class="box warningmessage" %)
	157	(((
	158	❗Une vérification sera effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
	159	)))
	160
	161	(% start="5" %)
	162	1. Cliquez sur le bouton Execute pour générer la clé API.
	163	➡ La réponse s'affiche dans la section Server response en-dessous.
	164	[[image:1745928288556-250.png\|\|alt="Réponse serveur"]]
	165	1. Copiez la clé API.
99.1	166	❗La clé affichée n'est affichée qu'une seule fois et ne peut être récupérée autrement car elle est hashée (cryptée de façon irréversible) lors du stockage sur le serveur pour des raisons de sécurité.(((
	167	Si une clé est perdue ou inutile, elle doit être invalidée et une autre clé doit être créée si nécessaire.
	168	)))
78.2	169
83.1	170	(% class="wikigeneratedid" %)
	171	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.//
	172
80.1	173	=== S'authentifier ===
7.1	174
80.1	175	Une fois la clé API générée, vous pouvez vous authentifier avec cette méthode :
7.1	176
5.4	177	1. Cliquez sur le bouton Authorize.
53.1	178	1. Dans la section BasicAuth, déconnectez-vous en cliquant sur le bouton Logout.
80.1	179	1. Dans la section ApiKeyAuth, collez la clé API dans le champ Value.
5.4	180	1. Cliquez sur Authorize.
	181
73.1	182	= Ressources API disponibles{{id name="ressources"/}} =
15.2	183
48.1	184	== Liste des ressources ==
18.1	185
48.1	186	Les ressources disponibles sont classées par type :
15.2	187
48.1	188	* Authentification : pour la création des jetons de sécurité (JWT)
98.1	189	* User Management : pour la gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, groupes d'autorisations des rôles, etc.
66.1	190	* Session Management : pour l'obtention de la liste des sessions, la supression de sessions.
48.1	191	* System : pour les informations système, service d'audit et ordonnanceur.
	192	* License Management : pour la gestion des licences : activation, utilisateurs dans la licence, etc.
	193	* Event Management : pour l'ajout d'évènements avec fireEvent.
66.1	194	* Connections : pour la gestion des connexions aux bases de donnnées : liste, création, remplacement, supression.
15.2	195
20.1	196	(% class="box infomessage" %)
	197	(((
49.1	198	ℹ Le cadenas fermé à droite de la ressource signifie que vous êtes autorisé.
20.1	199	)))
	200
15.3	201	== Opérations disponibles ==
	202
49.1	203	Il existe plusieurs types d'opérations pouvant être effectuées via l'API :
15.3	204
18.1	205	* (% style="color:#3498db" %)GET(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
	206	* (% style="color:#2ecc71" %)POST(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
	207	* (% 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.
	208	* (% style="color:#e67e22" %)PUT(%%) : pour remplacer des éléments (écrase toutes les données et les remplace).
	209	* (% style="color:#c0392b" %)DELETE(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
15.3	210
99.1	211	== Envoi de requêtes{{id name="envoi"/}} ==
20.1	212
60.1	213	(% class="box warningmessage" %)
	214	(((
	215	❗Pour rappel, une vérification est effectuée sur les autorisations de l'utilisateur dans Digdash (ACLs) en plus des droits du jetons.
	216	)))
	217
26.1	218	(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
27.1	219	(% 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 :
20.1	220
49.1	221	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é.
27.1	222	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.
	223	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" %)Dans la fenêtre de méthode développée, cliquez sur Try it out (Essayer) .
57.1	224	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.
27.1	225	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 Execute.(%%)
57.1	226	➡ (% 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.
	227	Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.
26.1	228
58.1	229	(% 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).
	230	À 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.
	231	[[image:1725441504464-493.png]]
	232
33.1	233	(% class="wikigeneratedid" id="HParamE8tres" %)
	234	Paramètres
31.1	235
94.3	236	(% style="width:1391px" %)
	237	\|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)User management
	238	\|(% 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.
	239	\|(% 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.
	240	\|(% 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.
53.1	241	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.
94.3	242	\|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)Session management
99.1	243	\|(% 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.
94.3	244	\|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)Connection management
95.1	245	\|(% 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.
	246	\|(% 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.
	247	\|(% 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.
	248	\|(% style="width:173px" %)id (obligatoire)\|(% style="width:1214px" %)Spécifiez l'identifiant de la connexion de base de données.
94.3	249	\|(% colspan="2" style="background-color:grey; text-align:center; width:1388px" %)(% style="color:#ffffff" %)License management
	250	\|(% style="width:173px" %)pattern\|(% style="width:1214px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
31.1	251	Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
	252
53.1	253	= Expiration de l'authentification =
35.1	254
	255	(% style="line-height:1.7142857142857142; background-color:#ffffff" %)
84.1	256	(% 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".
53.1	257	(% 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.
35.1	258
41.1	259	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.
84.1	260	1. Cliquez sur le bouton Logout en dessous de BearerAuth ou ApiKeyAuth.
46.1	261	1. Cliquez sur Close pour Fermer.
84.1	262	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"]].
87.1	263
87.2	264	= Invalider un jeton JWT ou une clé API =
87.1	265
89.2	266	== Invalider un jeton JWT ==
	267
87.2	268	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.
	269
89.2	270	== Invalider une clé API ==
	271
88.1	272	Pour une clé API, l'invalidation se fait de manière individuelle et globale.
87.2	273
90.1	274	Pour invalider une ou plusieurs clés :
88.1	275
90.1	276	(% start="1" %)
	277	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 :
	278	[[image:1745932166616-318.png\|\|alt="Liste clés API"]]
87.1	279
99.1	280	1. Envoyez une liste d'identifiants (en JSON ou XML selon le Content-Type comme expliqué dans la partie [[Envoi de requêtes>>doc:\|\|anchor="envoi"]]) à "POST /api/v1/auth/apikeys/delete" pour invalider une ou plusieurs clés
90.1	281
91.1	282	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.
90.1	283
	284
	285