Language	Title	Date
en	-	-
fr	-	-
es	-	-

Wiki source code of Digdash API

Version 34.1 by Aurelie Bertrand on 2024/08/29 17:15

version	line-number	content
19.1	1	{{ddtoc/}}
	2
	3	----
	4
15.1	5	= Accéder à Swagger UI =
1.2	6
	7	Swagger UI permet de visualiser et d'interagir avec les ressources des API.
	8	Cette interface fournit également une documentation visuelle facilitant leur utilisation.
	9
	10	Pour ouvrir Swagger UI, utilisez le lien suivant :
4.1	11	[[http:~~/~~/~[serveur~]:~[port~]/~[domaine~]/staticwebcontent/swagger/>>url:http://[serveur]:[port]/[domain]/updateuser]]
1.2	12	dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.
	13
	14	Par exemple:
	15	[[http:~~/~~/localhost:8080~~/~~/ddenterpriseapi/staticwebcontent/swagger/>>http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/]]
	16
	17	Vous accéderez ainsi à l'interface avec la liste des API disponibles classées par type.
	18
32.1	19	(% class="box infomessage" %)
	20	(((
	21	💡 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.
	22	)))
	23
1.2	24	= S'authentifier =
	25
	26	Afin de pouvoir interagir avec les API, vous devez vous authentifier.
	27
4.1	28	* (% 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é.)(%%)
	29	➡ (% 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	30
	31	Deux méthodes d'autorisation sont actuellement disponibles :
	32
	33	* (((
14.1	34	BasicAuth : La méthode Basic Authentification qui permet de s'identifier avec le nom d'utilisateur et mot de passe du LDAP.
1.2	35	)))
	36	* (((
	37	bearerAuth : La méthode Bearer Authentification (authentification du porteur) qui utilise des jetons de sécurité appelés jetons de porteur.
	38	)))
	39
	40	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.
	41
	42	(% class="box warningmessage" %)
	43	(((
	44	❗Il n'est pas recommandé d'utiliser la méthode BasicAuth de manière systématique pour des raisons de sécurité.
	45	)))
	46
25.1	47	(% class="box infomessage" %)
	48	(((
	49	ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).
	50	)))
	51
2.2	52	== Authentification via BasicAuth ==
1.3	53
1.4	54	1. Entrez votre nom d'utilisateur et mot de passe Digdash.
	55	1. Cliquez sur le bouton Authorize puis, une fois l'authentification effectuée, sur Close.
	56	➡ Le cadenas est à présent fermé, signifiant que vous êtes autorisé.
1.3	57
1.4	58	== Création du jeton de sécurité ==
1.3	59
1.4	60	Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :
	61
	62	1. Allez dans la section Authentication.
34.1	63	1. Cliquez pour déplier POST ddenterpriseapi/api/v1/auth/jwt.
1.4	64	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	65	1. Cliquez sur Try it out en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
	66	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	67	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	68	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	69	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	70	Par exemple :
7.1	71	[[image:Requête_jwt.png\|\|alt="Requête JWT"]]
21.1	72
	73	(% class="box warningmessage" %)
	74	(((
	75	❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.
	76	)))
	77
	78	(% start="5" %)
5.4	79	1. Cliquez sur le bouton Execute pour générer le jeton (JWT).
	80	➡ La réponse s'affiche dans la section Server response en-dessous.
	81	[[image:Réponse_requête_JWT.png\|\|alt="Réponse requête JWT"]]
	82	1. Copiez le jeton JWT.
3.1	83
9.1	84	=== Signature du jeton de sécurité ===
	85
	86	Une clé privée utilisée pour signer le JWT est codée en dur par défaut.
	87
10.1	88	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 :
9.1	89
10.1	90	* DD_JWT_SECRETKEY_PATH: cette variable permet de définir le chemin vers une clé privée RSA.
	91	* DD_JWT_SECRETKEY: cette variable permet de définir un mot de passe personnalisé.
9.1	92
10.1	93	À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.
9.1	94
10.1	95	La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :
9.1	96
10.1	97	{{code language="shell"}}
	98	openssl -genrsa -out /path/to/privatekey.pem 2048
	99	{{/code}}
9.1	100
10.1	101	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	102
10.1	103	{{code language="shell"}}
	104	openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt
	105	{{/code}}
9.1	106
8.1	107	== Authentification via BearerAuth ==
7.1	108
12.1	109	(% class="wikigeneratedid" id="HUnefoislejetondesE9curitE9gE9nE9rE92CvouspouvezvousauthentifieraveccettemE9thode:" %)
	110	(% style="font-size:14px" %)Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :
7.1	111
5.4	112	1. Cliquez sur le bouton Authorize.
13.1	113	1. Dans la section BasiAuthc, déconnectez-vous en cliquant sur le bouton Logout.
	114	1. Dans la section BearerAuth, collez le jeton JWT dans le champ Value.
5.4	115	1. Cliquez sur Authorize.
	116
15.2	117	= API disponibles =
	118
18.1	119	== Liste des API ==
	120
15.2	121	Les API disponibles sont classées par type :
	122
	123	* Authentification : contient l'API permettant, comme vu précédemment, la création des jetons de sécurité (JWT)
	124	* User Management : contient les API de gestion des utilisateurs et des éléments liés : profils, rôles, groupes d'autorisations, etc.
	125	* System : contient les API liées aux informations système, service d'audit et ordonnanceur.
	126	* License Management : contient les API de gestion des licences : activatio, utilisateurs dans la licence, etc.
	127	* Event Management : contient l'API permattant d'ajouter un évènement avec fireEvent.
	128
20.1	129	(% class="box infomessage" %)
	130	(((
24.1	131	ℹ Le cadenas fermé à droite le l'API signifie que vous êtes autorisé.
20.1	132	)))
	133
15.3	134	== Opérations disponibles ==
	135
	136	Il existe plusieurs types d'opérations pouvant être effectuées via les API :
	137
18.1	138	* (% style="color:#3498db" %)GET(%%) : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
	139	* (% style="color:#2ecc71" %)POST(%%) : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
	140	* (% 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.
	141	* (% style="color:#e67e22" %)PUT(%%) : pour remplacer des éléments (écrase toutes les données et les remplace).
	142	* (% style="color:#c0392b" %)DELETE(%%) : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.
15.3	143
23.1	144	== Envoi de requêtes ==
20.1	145
26.1	146	(% style="line-height:1.7142857142857142; background-color:#ffffff; margin-bottom:15px; padding:3.75pt 0pt 0pt 0pt" %)
27.1	147	(% 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	148
27.1	149	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é.
	150	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.
	151	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) .
33.1	152	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.
27.1	153	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.(%%)
	154	➡ (% 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.
26.1	155
33.1	156	(% class="wikigeneratedid" id="HParamE8tres" %)
	157	Paramètres
31.1	158
	159	(% style="width:785px" %)
	160	\|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)User management
	161	\|(% 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.
	162	\|(% 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.
	163	\|(% 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.
	164	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.
	165	\|(% colspan="2" style="background-color:grey; text-align:center; width:782px" %)(% style="color:#ffffff" %)License management
	166	\|(% style="width:173px" %)pattern\|(% style="width:608px" %)Vous pouvez spécifier une expression régulière permettant de filtrer les utilisateurs à récupérer.
	167	Par exemple, le pattern test.* va récupérer tous les utilisateurs dont le nom commence par test.
	168
	169
	170
29.1	171	= Expiration et révocation de l'accès =

Wiki source code of Digdash API

Sommaire