VISO TRUST

officiel

Accédez et gérez votre programme de risques tiers VISO TRUST directement via votre assistant IA.

Que pouvez-vous faire avec VISO TRUST MCP ?

  • Consulter les évaluations des fournisseurs — Récupérer une évaluation spécifique par ID, y compris son résumé généré par l’IA au format HTML ou Markdown.
  • Créer et gérer des évaluations — Lancer une évaluation pour une relation existante, mettre à jour sa date d’expiration ou ajuster les paramètres de suivi.
  • Rechercher des relations avec des fournisseurs — Filtrer les relations par balises, domaines, statuts, niveaux de risque, plages de scores, unités opérationnelles et dates.
  • Intégrer ou retirer des fournisseurs — Intégrer une relation avec un résumé d’approbation et des paramètres de cycle de vie, ou la retirer et l’archiver.
  • Consulter les journaux d’audit — Rechercher les événements d’audit liés aux utilisateurs, aux organisations, aux évaluations et aux relations sur une période donnée.
  • Gérer les rapports de veille — Créer, mettre à jour ou récupérer des rapports BitSight, SecurityScorecard et Recorded Future pour le domaine d’un fournisseur.

Documentation

Serveur MCP VISO TRUST

Un serveur Model Context Protocol (MCP) permettant d’intégrer les fonctionnalités de l’API VISO TRUST aux assistants IA.

Serveur distant hébergé

VISO TRUST héberge une instance gérée de ce serveur MCP. Vous n’avez donc pas besoin de le créer, de l’exécuter ni de l’héberger vous-même pour commencer :

https://mcp.visotrust.com/mcp

Connectez n’importe quel client MCP à ce point de terminaison à l’aide du transport Streamable HTTP et authentifiez-vous avec votre jeton API VISO TRUST. Pour savoir comment générer un jeton API, consultez la documentation d’assistance VISO TRUST.

Exemple de configuration client :

{
    "mcpServers": {
        "viso-mcp": {
            "type": "streamable-http",
            "url": "https://mcp.visotrust.com/mcp",
            "headers": {
                "Authorization": "Bearer <your-api-token>"
            }
        }
    }
}

Pour tester le point de terminaison hébergé avec MCP Inspector, exécutez npx @modelcontextprotocol/inspector, définissez Transport Type sur Streamable HTTP, puis utilisez l’URL ci-dessus.

Le reste de ce document explique comment exécuter vous-même le serveur (en local ou dans votre propre infrastructure).

Prérequis

  • Java 21+
  • Gradle
  • Docker (facultatif pour un déploiement conteneurisé)
  • MCP Inspector (facultatif pour les tests)

Configuration

Configuration de l’API VISO TRUST

Les propriétés suivantes peuvent être configurées pour l’API VISO TRUST :

  • visotrust.api.base-url : URL de base de l’API VISO TRUST (valeur par défaut : http://localhost:8080)
  • visotrust.api.token : votre jeton API de la plateforme VISO TRUST (obligatoire)
  • visotrust.api.timeout : délai d’expiration des requêtes API en millisecondes (valeur par défaut : 30000)
  • visotrust.api.connect-timeout : délai d’expiration de la connexion API en millisecondes (valeur par défaut : 5000)

Pour savoir comment générer un jeton API pour la variable d’environnement visotrust.api.token, consultez la documentation d’assistance VISO TRUST.

Profils d’application

Cette application prend en charge les profils Spring Boot afin d’activer différentes configurations selon les scénarios de déploiement.

Profil distant

Le profil remote est conçu pour la prise en charge de MCP à distance via le transport Streamable HTTP. Ce profil exécute le serveur en tant qu’application web afin qu’il puisse communiquer avec des clients distants via HTTP. (Streamable HTTP remplace le transport SSE obsolète ; il est configuré ici en mode sans état.)

Principales différences du profil distant :

  • S’exécute en tant qu’application web servlet (Tomcat) sur le port 3001 plutôt qu’en E/S standard
  • Expose le point de terminaison MCP à l’adresse POST /mcp (Streamable HTTP)
  • Fonctionne en mode sans état — aucun état serveur par session, ce qui permet une mise à l’échelle horizontale derrière un équilibreur de charge sans affinité de session
  • Paramètres serveur optimisés pour les connexions de clients distants
  • Journalisation améliorée pour le débogage distribué

Remarque : les clients se connectent au point de terminaison Streamable HTTP unique …/mcp. Les anciens points de terminaison SSE (/sse + /mcp/message) ne sont plus disponibles.

Activation du profil distant :

Exécution directe avec Java :

java -jar viso-mcp-server-<version>.jar --spring.profiles.active=remote

Exécution avec Gradle :

./gradlew bootRun --args="--spring.profiles.active=remote"

Utilisation de Docker :

docker run -i --rm \
  -e VISOTRUST_API_TOKEN=<your-api-token> \
  -e SPRING_PROFILES_ACTIVE=remote \
  viso-mcp-server

Quand utiliser le profil distant :

  • Pour déployer le serveur MCP sur un serveur distant ou dans un environnement cloud
  • Lorsque les clients se connectent via Streamable HTTP plutôt que directement via stdio
  • Lorsque vous avez besoin d’une journalisation et d’une surveillance améliorées pour les déploiements distribués
  • Pour l’intégration avec des assistants IA web qui se connectent via Streamable HTTP

Pour le développement local et la communication directe via stdio, utilisez le profil par défaut (aucune spécification de profil n’est nécessaire).

Installation

Installation rapide

Cliquez sur l’un des boutons ci-dessous pour installer le serveur MCP VISO dans VS Code :

Install with Docker in VS Code Install with Docker in VS Code Insiders

Configuration manuelle avec VS Code

Ajoutez le bloc JSON suivant au fichier User Settings (JSON) de VS Code. Pour cela, appuyez sur Ctrl + Shift + P et saisissez Preferences: Open User Settings (JSON).

{
  "mcp": {
    "inputs": [
      {
        "type": "promptString",
        "id": "viso_baseurl",
        "description": "VISO TRUST API Base URL",
        "default": "https://app.visotrust.com"
      },
      {
        "type": "promptString",
        "id": "viso_token",
        "description": "VISO TRUST API Token",
        "password": true
      }
    ],
    "servers": {
      "viso-mcp": {
        "command": "docker",
        "args": [
          "run",
          "-i",
          "--rm",
          "-e",
          "VISOTRUST_API_TOKEN",
          "-e",
          "VISOTRUST_API_BASEURL",
          "visotrustai/viso-mcp-server:latest"
        ],
        "env": {
          "VISOTRUST_API_BASEURL": "${input:viso_baseurl}",
          "VISOTRUST_API_TOKEN": "${input:viso_token}"
        }
      }
    }
  }
}

Vous pouvez également ajouter un exemple similaire (c’est-à-dire sans la clé mcp) dans un fichier nommé .vscode/mcp.json de votre espace de travail. Vous pourrez ainsi partager la configuration avec d’autres personnes.

{
  "inputs": [
    {
      "type": "promptString",
      "id": "viso_baseurl",
      "description": "VISO TRUST API Base URL",
      "default": "https://app.visotrust.com"
    },
    {
      "type": "promptString",
      "id": "viso_token",
      "description": "VISO TRUST API Token",
      "password": true
    }
  ],
  "servers": {
    "viso-mcp": {
      "command": "docker",
      "args": [
        "run",
        "-i",
        "--rm",
        "-e",
        "VISOTRUST_API_TOKEN",
        "-e",
        "VISOTRUST_API_BASEURL",
        "visotrustai/viso-mcp-server:latest"
      ],
      "env": {
        "VISOTRUST_API_BASEURL": "${input:viso_baseurl}",
        "VISOTRUST_API_TOKEN": "${input:viso_token}"
      }
    }
  }
}

Utilisation avec Claude Desktop et d’autres clients MCP

Configuration Docker

{
    "mcpServers": {
        "viso-mcp": {
            "command": "docker",
            "args": [
                "run",
                "-i",
                "--rm",
                "-e", "VISOTRUST_API_TOKEN",
                "-e", "VISOTRUST_API_BASEURL",
                "visotrustai/viso-mcp-server:latest"
            ],
            "env": {
                "VISOTRUST_API_TOKEN": "<your-api-token>",
                "VISOTRUST_API_BASEURL": "https://app.visotrust.com"
            }
        }
    }
}

Configuration Java

{
    "mcpServers": {
        "viso-mcp": {
            "command": "java",
            "args": [
                "-jar",
                "viso-mcp-server-<version>.jar",
                "--port",
                "8080",
                "--host",
                "localhost"
            ],
            "env": {
                "JAVA_TOOL_OPTIONS": "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005",
                "VISOTRUST_API_TOKEN": "<your-api-token>",
                "VISOTRUST_API_BASEURL": "https://app.visotrust.com"
            }
        }
    }
}

Remarque : la variable d’environnement JAVA_TOOL_OPTIONS sert à définir les options de la JVM pour le débogage à distance. L’adresse et le port peuvent être modifiés selon les besoins.

💻 Développement

Configuration Docker

Créer l’image Docker

docker build -t viso-mcp-server .

Exécuter le conteneur Docker

docker run -i --rm -e VISOTRUST_API_TOKEN=<your-api-token> viso-mcp-server

Débogage

Installer MCP Inspector

npm -g install @modelcontextprotocol/inspector

Exécuter MCP Inspector pour les tests

  1. Créer le fichier JAR du serveur MCP
./gradlew bootJar
  1. Exécuter MCP Inspector
npx @modelcontextprotocol/inspector \
    -e JAVA_TOOL_OPTIONS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=\*:5005 \
    -e VISOTRUST_API_TOKEN=<your-api-token> \
    java -jar build/libs/viso-mcp-server-<version>.jar \
    --port 8080 --host localhost

Remplacez <version> par la version actuelle du projet (par exemple, 1.0.0 ou la version de la dernière publication).

Pipeline CI/CD

Ce projet utilise GitHub Actions pour l’intégration et le déploiement continus. Le workflow comprend les tâches suivantes :

Lint

Vérifie le formatage du code avec Spotless :

./gradlew spotlessCheck

Build

Compile l’application et crée un fichier JAR :

./gradlew build

Publish

Lorsqu’une nouvelle version est créée :

  1. Met à jour la version du projet dans build.gradle pour qu’elle corresponde au tag de publication
  2. Téléverse le fichier JAR vers la publication GitHub avec la version du tag de publication
  3. Crée et publie l’image Docker sur Docker Hub avec les tags suivants :
    • latest
    • Le tag de publication (par exemple, v1.0.0)
Secrets requis pour la publication

Pour activer la publication sur Docker Hub, ajoutez ces secrets à votre dépôt GitHub :

  • DOCKERHUB_USERNAME : votre nom d’utilisateur Docker Hub
  • DOCKERHUB_TOKEN : votre jeton d’accès Docker Hub

🛠️ Outils

Cette section présente la documentation des outils exposés par le serveur MCP VISO. Chaque outil a un objectif, des paramètres d’entrée et un format de sortie spécifiques.

Évaluations

get_assessment - Obtenir une évaluation par son ID

  • id : ID de l’évaluation (nombre, obligatoire)

Renvoie des informations détaillées sur une évaluation spécifique.

get_assessment_summary - Obtenir le résumé d’une évaluation par son ID

  • id : ID de l’évaluation (nombre, obligatoire)
  • format : HTML (par défaut) ou MARKDOWN (chaîne, facultatif)

Renvoie le résumé, son version et indique s’il a été edited.

update_assessment_summary - Remplacer le texte du résumé d’une évaluation terminée généré par l’IA

  • id : ID de l’évaluation (nombre, obligatoire)
  • summary : résumé modifié (chaîne, obligatoire)
  • format : HTML (par défaut) ou MARKDOWN (chaîne, facultatif)
  • version : le version de get_assessment_summary ; la mise à jour est rejetée si le résumé a changé depuis (chaîne, facultatif)

Renvoie le résumé mis à jour dans le format utilisé pour l’envoi.

create_assessment - Démarrer une évaluation pour une relation existante

  • relationshipId : ID de la relation pour laquelle créer une évaluation (nombre, obligatoire)
  • recipientEmail : adresse e-mail du destinataire de l’évaluation (chaîne, facultatif)
  • recipientFirstName : prénom du destinataire de l’évaluation (chaîne, facultatif)
  • recipientLastName : nom du destinataire de l’évaluation (chaîne, facultatif)
  • publicDocumentUrls : URL des documents publics à inclure dans l’évaluation (chaîne[], facultatif)
  • followupType : type de suivi (énumération de chaînes, facultatif)
  • followupRiskThreshold : seuil de niveau de risque déclenchant un suivi (énumération de chaînes, facultatif)
  • followupTimeline : calendrier des actions de suivi (énumération de chaînes, facultatif)
  • collectionTimeline : délai accordé au fournisseur pour envoyer sa réponse à l’évaluation (énumération de chaînes, facultatif)
  • noVendorResponseAction : action à entreprendre si le fournisseur ne répond pas (énumération de chaînes, facultatif)
  • aiProcessingOnly : indique si le traitement doit être effectué uniquement par l’IA, sans examen humain (booléen, facultatif)
  • requestedAuditTypes : types d’audits demandés pour cette évaluation (chaîne[], facultatif)

Renvoie les détails de l’évaluation créée.

update_assessment_expiration_date - Modifier la date limite à laquelle le fournisseur doit envoyer sa réponse à l’évaluation

  • id : ID de l’évaluation (nombre, obligatoire)
  • expirationDate : nouvelle date/heure d’expiration, au format ISO-8601 avec décalage ; doit être dans le futur (chaîne, obligatoire)

Renvoie un message de confirmation.

update_assessment_followup - Modifier la configuration de suivi d’une évaluation

  • id : ID de l’évaluation (nombre, obligatoire)
  • followupType : type de suivi (énumération de chaînes, obligatoire)
  • followupRiskThreshold : seuil de risque à partir duquel une évaluation de suivi doit être déclenchée (énumération de chaînes, facultatif)
  • followupTimeline : calendrier de suivi (énumération de chaînes, facultatif)

Renvoie un message de confirmation.

Journaux d’audit

get_user_audit_log_events - Obtenir les événements du journal d’audit de votre organisation associés à un utilisateur

  • start : date/heure de début de la requête, au format ISO-8601 avec décalage (chaîne, obligatoire)
  • end : date/heure de fin de la requête, au format ISO-8601 avec décalage (chaîne, obligatoire)
  • eventTypes : ensemble facultatif de types d’événements à filtrer (par exemple, USER_LOGGED_IN) ; laissez vide pour tout inclure (chaîne[], facultatif)

Renvoie une liste d’événements du journal d’audit utilisateur, limitée à 500 enregistrements.

get_audit_log_events - Obtenir les événements filtrés du journal d’audit (utilisateur, organisation, évaluation et relation)

  • start : date/heure de début de la requête, au format ISO-8601 avec décalage (chaîne, obligatoire)
  • end : date/heure de fin de la requête, au format ISO-8601 avec décalage (chaîne, obligatoire)
  • eventTypes : ensemble facultatif de types d’événements à filtrer (par exemple, ASSESSMENT_COMPLETED, RELATIONSHIP_CREATED) ; laissez vide pour tout inclure (chaîne[], facultatif)

Renvoie des enregistrements polymorphes d’événements du journal d’audit. Chaque élément contient au minimum auditEventType et dateTime.

Unités opérationnelles

get_all_business_units - Obtenir toutes les unités opérationnelles de votre organisation, triées par nom

Renvoie pour chaque unité opérationnelle son id (utilisable comme filtre businessUnitIds dans search_relationships) et son name (utilisable comme businessUnit dans create_user).

Cas d’affaires

get_all_business_cases - Obtenir tous les cas d’affaires disponibles pour votre organisation

Aucun paramètre requis.

Renvoie la liste de tous les cas d’affaires disponibles pour votre organisation.

Types de données

get_all_datatypes - Obtenir tous les types de données disponibles pour votre organisation

Aucun paramètre requis.

Renvoie la liste de tous les types de données disponibles pour votre organisation.

Répertoire des fournisseurs

search_vendor_directory - Rechercher un fournisseur dans le répertoire des fournisseurs VISO TRUST par URL ou domaine

  • urlOrDomain : URL ou nom de domaine à rechercher, par exemple example.com (chaîne, obligatoire)

Renvoie les métadonnées de base du fournisseur (nom, page d’accueil, description, favicon, domaines connus).

Relations

get_all_relationships - Obtenir la liste de toutes les relations et les détails de leurs évaluations

Aucun paramètre requis.

Renvoie des informations sur les fournisseurs tiers, notamment l’état de leurs évaluations, leurs niveaux de risque et leurs coordonnées.

get_relationship_by_id - Obtenir une relation spécifique et les détails de son évaluation par ID

  • id : ID de la relation (nombre, obligatoire)

Renvoie des informations détaillées sur un fournisseur tiers, notamment l’état de son évaluation, ses niveaux de risque et ses coordonnées.

get_relationship_assessment_history - Obtenir l’historique des évaluations d’une relation

  • id : ID de la relation (nombre, obligatoire)

Renvoie la liste des évaluations associées à la relation spécifiée.

create_relationship - Créer une relation avec un fournisseur tiers

  • name : nom de la relation/du fournisseur (chaîne, obligatoire)
  • homepage : URL de la page d’accueil du fournisseur (chaîne, obligatoire)
  • businessOwnerEmail : adresse e-mail du responsable métier (chaîne, obligatoire)
  • businessOwnerFirstName : prénom du responsable métier (chaîne, facultatif)
  • businessOwnerLastName : nom du responsable métier (chaîne, facultatif)
  • description : description de la relation/du fournisseur (chaîne, facultatif)
  • contextTypes : liste des types de contexte métier pour cette relation (object[], facultatif)
  • dataTypes : liste des types de données traités dans le cadre de cette relation (object[], facultatif)
  • tags : liste de tags permettant de catégoriser cette relation (string[], facultatif)
  • thirdPartyContact : coordonnées du représentant du fournisseur tiers (object, facultatif)

Renvoie les détails de la relation créée.

create_relationship_by_domain - Créer une nouvelle relation en utilisant uniquement le domaine du fournisseur

  • domain : Domaine du fournisseur, par ex. visotrust.com (string, obligatoire)
  • vendorName : Nom du fournisseur (string, obligatoire)
  • product : Produit proposé par le fournisseur (string, facultatif)
  • description : Description de la relation avec le fournisseur (string, facultatif)

Renvoie les détails de la relation créée.

update_relationship - Mettre à jour une relation existante avec un fournisseur tiers

  • id : ID de la relation (number, obligatoire)
  • name : Nom de la relation/du fournisseur (string, obligatoire)
  • homepage : URL de la page d’accueil du fournisseur (string, facultatif)
  • description : Description de la relation/du fournisseur (string, facultatif)
  • contextTypes : Liste des types de contexte métier (object[], facultatif)
  • dataTypes : Liste des types de données traités dans cette relation (object[], facultatif)
  • businessOwnerEmail : Adresse e-mail du responsable métier (string, facultatif)
  • businessOwnerFirstName : Prénom du responsable métier (string, facultatif)
  • businessOwnerLastName : Nom du responsable métier (string, facultatif)
  • tags : Liste d’étiquettes (string[], facultatif)

Renvoie les détails de la relation mise à jour.

partially_update_relationship - Mettre à jour partiellement une relation existante

Accepte les mêmes champs que update_relationship. Seuls les champs fournis dans la requête sont modifiés ; les autres restent inchangés.

Renvoie les détails de la relation mise à jour.

search_relationships - Rechercher des relations selon des critères de filtrage

Appelle POST /api/v1/relationships/search. Tous les filtres sont facultatifs ; les filtres sont combinés avec AND, et les valeurs d’un même filtre de liste sont combinées avec OR.

  • request : Filtres de recherche (object, facultatif)
    • tags : Noms des étiquettes, exactement tels qu’ils apparaissent dans VISO TRUST (string[], facultatif)
    • domains : Noms de domaine des fournisseurs, par ex. example.com (string[], facultatif)
    • name : Nom exact de la relation (string, facultatif)
    • externalId : ID externe exact (string, facultatif)
    • statuses : Statuts de la relation — NOT_ONBOARDED, ONBOARDED, ARCHIVED (string[], facultatif)
    • assessmentStatuses : Statuts de la dernière évaluation (string[], facultatif)
    • riskAcceptanceStatuses : RISK_ACCEPTED, REVIEW_NEEDED, REMEDIATION_REQUESTED (string[], facultatif)
    • inherentRiskLevels / residualRiskLevels : NO_CONTEXT, LOW, MEDIUM, HIGH, EXTREME (string[], facultatif)
    • minScore / maxScore : Plage de scores, bornes incluses (number, facultatif)
    • businessUnitIds : ID des unités opérationnelles provenant de get_all_business_units (number[], facultatif)
    • businessOwnerIds / creatorIds : ID des utilisateurs provenant de get_all_users (number[], facultatif)
    • createdAfter / createdBefore, onboardedAfter / onboardedBefore, recertificationAfter / recertificationBefore, assessmentCompletedAfter / assessmentCompletedBefore : Dates et heures au format ISO-8601 (string, facultatif)
  • page : Numéro de page à partir de zéro (number, facultatif, valeur par défaut 0)
  • size : Taille de la page (number, facultatif, valeur par défaut 100, maximum 500)
  • sort : Ordres de tri au format property,asc|desc ; propriétés name, externalId, score, createdDate, onboardedDate, recertificationDate (string[], facultatif)

Renvoie totalCount, page, size, hasMore et la page de relationships correspondantes.

create_tags - Créer de nouvelles étiquettes pour catégoriser les relations

  • tags : Liste des noms d’étiquettes à créer (string[], obligatoire)

Renvoie la liste de toutes les étiquettes, y compris celles qui viennent d’être créées.

update_third_party_contact - Mettre à jour les coordonnées d’un fournisseur tiers

  • relationshipId : ID de la relation (number, obligatoire)
  • email : Adresse e-mail du contact (string, obligatoire)
  • firstName : Prénom du contact (string, obligatoire)
  • lastName : Nom du contact (string, obligatoire)

Renvoie les détails de la relation mise à jour.

onboard_relationship - Intégrer une relation, avec éventuellement un résumé d’approbation et des paramètres de gestion du cycle de vie

  • id : ID de la relation (number, obligatoire)
  • approvalSummary : Résumé facultatif de l’approbation consigné lors de l’intégration (string, facultatif)
  • lifecycleManagementUpdateRequest : Paramètres facultatifs de gestion du cycle de vie (object, facultatif)
    • artifactUpdateSettings.artifactUpdateType : Type de mise à jour de l’artefact (string enum)
    • recertificationSettings.recertificationType : Type de recertification (string enum)
    • recertificationSettings.recertificationDate : Date/heure de la prochaine recertification, au format ISO-8601 avec décalage horaire (string)
    • recertificationSettings.reviewFrequency : THREE_YEARS, TWO_YEARS, ANNUAL, SEMIANNUAL ou QUARTERLY (string enum)

Renvoie les détails de la relation intégrée.

offboard_relationship - Mettre fin à une relation

  • id : ID de la relation (number, obligatoire)

Renvoie les détails de la relation clôturée.

accept_relationship_risk - Accepter le risque d’une relation

  • id : ID de la relation (number, obligatoire)
  • request : (object, facultatif)
    • riskReviewNote : Note expliquant la décision (string, facultatif)
    • inherentRiskOverride / residualRiskOverride : LOW, MEDIUM, HIGH ou EXTREME ; fournir les deux ou aucun (string, facultatif)

Renvoie la relation mise à jour.

get_relationship_detections - Obtenir les détections trouvées dans les éléments probants d’une relation

  • id : ID de la relation (number, obligatoire)
  • detectionTypes : NORMAL, SUBSERVICE, SHARED_RESPONSIBILITY_MODEL, EXCEPTION, CUEC, SUBPROCESSOR ; par défaut, tous sauf NORMAL (string[], facultatif)
  • controlDomainTypes : Types de domaines de contrôle à inclure ; tous sont inclus par défaut (string[], facultatif)
  • assessmentId : Évaluation terminée de cette relation, ou dernière évaluation en cours (number, facultatif)
  • includeQuestionnaireAnswers : Inclure les réponses à l’origine des détections du questionnaire complémentaire (boolean, facultatif)
  • afterId : nextAfterId de la page précédente (number, facultatif)
  • size : Nombre de détections par page, de 1 à 500 (number, facultatif, valeur par défaut 100)

Renvoie une page de détections ; poursuivez la lecture tant que nextAfterId n’est pas null.

get_risk_advisories_by_relationship - Obtenir les avis de risque concernant le fournisseur d’une relation

  • id : ID de la relation (number, obligatoire)

archive_relationship - Archiver une relation

  • id : ID de la relation (number, obligatoire)

Renvoie les détails de la relation archivée.

Webhooks

get_all_webhooks - Obtenir tous les webhooks

Aucun paramètre requis.

Renvoie la liste de toutes les configurations de webhook.

get_webhook - Obtenir une configuration de webhook par ID

  • id : ID du webhook (number, obligatoire)

Renvoie les détails d’une configuration de webhook spécifique.

create_webhook_configuration - Créer une configuration de webhook

  • request : Paramètres de création du webhook (object, obligatoire)
    • url : URL du webhook (string, obligatoire)
    • secret : Secret du webhook (string, obligatoire)
    • eventTypes : Types d’événements qui déclenchent le webhook (string[], obligatoire)
    • serviceType : Type de service du webhook (string, obligatoire)

Renvoie la configuration de webhook créée.

update_webhook_configuration - Mettre à jour une configuration de webhook

  • request : Paramètres de mise à jour du webhook (object, obligatoire)
    • id : ID du webhook (number, obligatoire)
    • url : URL du webhook (string, facultatif)
    • secret : Secret du webhook (string, facultatif)
    • eventTypes : Types d’événements qui déclenchent le webhook (string[], facultatif)
    • serviceType : Type de service du webhook (string, facultatif)

Renvoie la configuration de webhook mise à jour.

delete_webhook_configuration - Supprimer une configuration de webhook

  • id : ID du webhook (number, obligatoire)

Supprime la configuration de webhook spécifiée.

Rapports de renseignement

create_bitsight_intelligence_report - Créer un rapport de renseignement BitSight

  • request : Paramètres du rapport BitSight (object, obligatoire)
    • vendorDomain : Nom de domaine principal du fournisseur (string, obligatoire)
    • reportDate : Date/heure de génération du rapport (string au format ISO 8601, obligatoire)
    • link : Lien facultatif vers l’interface du fournisseur (string, facultatif)
    • guid : GUID BitSight de l’entité (string, obligatoire)
    • customId : Identifiant personnalisé de BitSight (string, facultatif)
    • name : Nom d’affichage de l’entité BitSight (string, facultatif)
    • description : Description de l’entité BitSight (string, facultatif)
    • primaryDomain : Domaine principal de l’entité BitSight (string, facultatif)
    • ratingRange : Plage de notation BitSight (string, facultatif)
    • ratingColor : Couleur de notation BitSight (string, facultatif)
    • confidence : Niveau de confiance de la notation BitSight (string, facultatif)

Renvoie le rapport de renseignement créé.

create_security_scorecard_intelligence_report - Créer un rapport de renseignement SecurityScorecard

  • request : Paramètres du rapport SecurityScorecard (object, obligatoire)
    • vendorDomain : Nom de domaine principal du fournisseur (string, obligatoire)
    • reportDate : Date/heure de génération du rapport (string au format ISO 8601, obligatoire)
    • link : Lien facultatif vers l’interface du fournisseur (string, facultatif)
    • grade : Note alphabétique SecurityScorecard (string, obligatoire)
    • domain : Domaine associé à l’entité SecurityScorecard (string, facultatif)
    • score : Score numérique de SecurityScorecard (number, facultatif)

Renvoie le rapport de renseignement créé.

create_recorded_future_intelligence_report - Créer un rapport de renseignement Recorded Future

  • request : Paramètres du rapport Recorded Future (object, obligatoire)
    • vendorDomain : Nom de domaine principal du fournisseur (string, obligatoire)
    • reportDate : Date/heure de génération du rapport (string au format ISO 8601, obligatoire)
    • entityType : Type d’entité Recorded Future, par ex. Company (string, obligatoire)
    • entity : Identifiant de l’entité Recorded Future (string, obligatoire)
    • riskScore : Score de risque numérique (number, obligatoire)
    • riskLevel : Libellé du niveau de risque, par ex. Critical/High/Medium/Low (string, obligatoire)
    • link : Lien facultatif vers le rapport dans l’interface du fournisseur (string, facultatif)
    • firstSeen : Date de première observation de l’entité, au format ISO 8601 (string, facultatif)
    • lastSeen : Date de dernière observation de l’entité, au format ISO 8601 (string, facultatif)
    • triggeredRuleCount : Nombre de règles Recorded Future déclenchées (number, facultatif)
    • maxRuleCount : Nombre maximal de règles Recorded Future évaluées (number, facultatif)
    • summary : Texte récapitulatif facultatif de Recorded Future (string, facultatif)
    • criticalityLabel : Libellé de criticité Recorded Future de l’entité (string, facultatif)

Renvoie le rapport de renseignement créé.

get_intelligence_reports_by_vendor - Obtenir tous les rapports de renseignement d’un fournisseur

  • vendorDomain : Nom de domaine principal du fournisseur (string, obligatoire)

Renvoie la liste des rapports de renseignement du fournisseur spécifié.

get_intelligence_report - Obtenir un rapport de renseignement par ID

  • id : ID du rapport (UUID, obligatoire)

update_bitsight_intelligence_report, update_security_scorecard_intelligence_report, update_recorded_future_intelligence_report - Remplacer un rapport de renseignement existant

  • id : ID du rapport (UUID, obligatoire)
  • request : Mêmes champs que l’outil create_*_intelligence_report correspondant. Les champs facultatifs omis sont effacés.

delete_intelligence_report - Supprimer définitivement un rapport de renseignement

  • id : ID du rapport (UUID, obligatoire)

bulk_create_bitsight_intelligence_reports, bulk_create_security_scorecard_intelligence_reports, bulk_create_recorded_future_intelligence_reports - Créer jusqu’à 1000 rapports de renseignement à la fois

  • reports : Mêmes champs que l’outil create_*_intelligence_report correspondant (object[], obligatoire)

Renvoie totalCount, les ID des rapports created, et backgroundedCount pour les rapports dont la création est mise en file d’attente en arrière-plan.

get_latest_intelligence_report - Obtenir le dernier rapport de renseignement d’un fournisseur auprès d’une source spécifique

  • vendorDomain : Nom de domaine principal du fournisseur (string, obligatoire)
  • source : Fournisseur de renseignements (string enum : BITSIGHT, SECURITY_SCORECARD ou RECORDED_FUTURE, obligatoire)

Renvoie le dernier rapport de renseignement pour le fournisseur et la source spécifiés.

Avis de risque

get_risk_advisories_by_vendor - Obtenir tous les avis de risque concernant un fournisseur

  • vendorId : ID du fournisseur (number, obligatoire)

Renvoie les avis de sécurité, de conformité, de vulnérabilité, juridiques, géopolitiques, financiers et opérationnels publiés concernant le fournisseur.

Utilisateurs

get_all_users - Obtenir tous les utilisateurs de votre organisation

  • page : page de résultats à récupérer (nombre, facultatif ; valeur par défaut : 0)
  • size : nombre d’enregistrements par page (nombre, facultatif ; valeur par défaut : 20)
  • sort : critères de tri au format : propriété(,asc|desc) (chaîne, facultatif)

Renvoie une liste paginée d’utilisateurs.

get_user_by_email - Obtenir un utilisateur par e-mail

  • email : adresse e-mail de l’utilisateur (chaîne, obligatoire)

Renvoie les détails de l’utilisateur.

create_user - Créer un nouvel utilisateur

  • request : paramètres de création de l’utilisateur (objet, obligatoire)
    • email : adresse e-mail du nouvel utilisateur (chaîne, obligatoire)
    • firstName : prénom du nouvel utilisateur (chaîne, obligatoire)
    • lastName : nom du nouvel utilisateur (chaîne, obligatoire)

Renvoie l’utilisateur créé.

Formatage du code

Ce projet utilise Spotless avec Google Java Format pour le formatage du code. Un hook pre-commit est automatiquement configuré afin de garantir un style de code cohérent.

Configuration

Après avoir cloné le dépôt, le hook pre-commit sera automatiquement configuré lorsque vous exécuterez une commande Gradle.

Formatage manuel

Pour formater manuellement tous les fichiers :

./gradlew spotlessApply

Pour vérifier que les fichiers sont correctement formatés :

./gradlew spotlessCheck

Si le hook pre-commit rejette votre commit en raison de problèmes de formatage, exécutez simplement ./gradlew spotlessApply pour corriger le formatage, puis réessayez de valider.

Licence

Ce projet est distribué sous licence MIT. Consultez le fichier LICENSE pour plus de détails.