Digdash API

Versión 41.1 por Aurelie Bertrand el 2024/08/30 09:36

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, utilisez le lien suivant :
http://[serveur]:[port]/[domaine]/staticwebcontent/swagger/
dans lequel vous remplacez [serveur], [port] et [domaine] par vos informations.

Par exemple:
http://localhost:8080//ddenterpriseapi/staticwebcontent/swagger/

Vous accéderez ainsi à l'interface avec les ressources des API disponibles, classées par type.

💡 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.

DD_API.png

S'authentifier

Afin de pouvoir interagir avec les API, vous devez vous authentifier.

  • Cliquez sur le bouton Authorize en haut à droite de la page Digdash API. (Le cadenas ouvert signifie que vous n’êtes pas autorisé.)
    ➡ La fenêtre Available authorizations (Autorisations disponibles) s'affiche.

Deux méthodes d'autorisation sont actuellement disponibles :

  • 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. 

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.

❗Il n'est pas recommandé d'utiliser la méthode BasicAuth de manière systématique pour des raisons de sécurité.

ℹ Il n'est pas possible de créer un jeton de sécurité (JWT) quand authentifié avec un jeton de sécurité (JWT).

Authentification via BasicAuth

  1. Entrez votre nom d'utilisateur et mot de passe Digdash.
  2. 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éation du jeton de sécurité

Nous allons créer ici le jeton de sécurité Json Web Token (JWT) :

  1. Allez dans la section Authentication.
  2. Cliquez pour déplier POST ddenterpriseapi/api/v1/auth/jwt.
  3. 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.
  4. Cliquez sur Try it out en haut à droit afin de définir votre requête. Celle-ci comprend les éléments suivants :
    • 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é.
      S'il n'est pas renseigné, l'utilisateur utilisé par défaut est celui connecté, ce qui sera généralement le cas.
    • 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.
    • permissions : Définissez les droits pour chaque type d'API : "none" pour aucun droit, "r" pour lecture seule, "rw" pour lecture-écriture.
      Par exemple :
      Requête JWT

❗Une vérification sera effectuée sur les autorisations de l'utiisateur dans Digdash (ACLs) en plus des droits du jetons.

  1. Cliquez sur le bouton Execute pour générer le jeton (JWT).
    ➡ La réponse s'affiche dans la section Server response en-dessous.
    Réponse requête JWT
  2. Copiez le jeton JWT.

Signature du jeton de sécurité

Une clé privée utilisée pour signer le JWT est codée en dur par défaut.

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é.

À noter quer la variable DD_JWT_SECRETKEY_PATH est prioritaire sur la variable DD_JWT_SECRETKEY.

La clé privée RSA peut être générée à l'aide de la commande suivante (nécessite l'outil openssl) :

openssl -genrsa -out /path/to/privatekey.pem 2048

La clé publique RSA peut être générée à partir de la clé privée à l'aide de la commande suivante (optionnel):

openssl rsa -in /path/to/privatekey.pem -pubout -out /path/to/publickey.crt

Authentification via BearerAuth

Une fois le jeton de sécurité généré, vous pouvez vous authentifier avec cette méthode :

  1. Cliquez sur le bouton Authorize.
  2. Dans la section BasiAuthc, déconnectez-vous en cliquant sur le bouton Logout.
  3. Dans la section BearerAuth, collez le jeton JWT dans le champ Value.
  4. Cliquez sur Authorize.

API disponibles

Liste des API

Les API disponibles sont classées par type :

  • 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.

ℹ 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 les API :

  • GET : pour obtenir des informations. Par exemple, la liste des utilisateurs ou les informations système.
  • POST : pour créer des éléments. Par exemple, un rôle ou des utilisateurs dans une licence.
  • PATCH : pour mettre à jour des éléments (remplace seulement les données à mettre à jour). Par exemple, un utilisateur ou un groupe d'autorisations.
  • PUT : pour remplacer des éléments (écrase toutes les données et les remplace).
  • DELETE : pour supprimer des éléments. Par exemple, des autorisations d'un utilisateur.

Envoi de requêtes

Lorsque vous y êtes autorisé, vous pouvez effectuer des requêtes :

  1. Développez une API avec laquelle vous souhaitez effectuer une opération. Le cadenas fermé signifie que vous êtes autorisé.
  2. 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.
  3. Dans la fenêtre de méthode développée, cliquez sur Try it out (Essayer) .
  4. Spécifiez les valeurs des paramètres si nécessaire. Une description est donnée ci-dessous.
  5. Cliquez sur Execute.
    ➡ La requête est exécutée. Un en-tête d'autorisation du porteur est automatiquement utilisé pour vos demandes.

Paramètres

User management
includesVous pouvez ajouter les rôles, autorisations (acls) et/ou groupes d'autorisations (groupacls) au résultat de la requête.
id (obligatoire)Spécifiez le nom de l'utilisateur, rôle.. selon l'API à utiliser pour l'opération.
resolveProfilesSi 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.
License management
patternVous 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 et révocation de l'authentification

Lorsque le jeton d'accès expire, vous recevez une réponse 401: "Unauthorized".
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. Pour invalider le jeton :

  1. Cliquez sur le bouton Authorize pour ouvrir la fenêtre Available authorizations.
  2. Cliquez sur le bouton Logout en dessous de BearerAuth.