VISO TRUST

offiziell

Greifen Sie auf Ihr VISO TRUST Drittanbieter-Risikoprogramm zu und verwalten Sie es direkt über Ihren KI-Assistenten.

Was kann man mit VISO TRUST MCP machen?

  • Vendor-Verzeichnis nach Domain durchsuchen — Suchen Sie einen Vendor in VISO TRUST mit search_vendor_directory anhand einer URL oder eines Domainnamens.
  • Drittanbieterbeziehungen verwalten — Erstellen, aktualisieren, durchsuchen, onboarden, offboarden oder archivieren Sie Vendor-Beziehungen mit Tools wie create_relationship, update_relationship und onboard_relationship.
  • Vendor-Assessments durchführen und verfolgen — Starten Sie ein Assessment mit create_assessment, rufen Sie Ergebnisse über get_assessment ab und aktualisieren Sie Fristen oder Nachverfolgungseinstellungen.
  • Audit-Log-Aktivitäten überprüfen — Fragen Sie Benutzer- oder vollständige Audit-Ereignisse mit get_user_audit_log_events und get_audit_log_events für einen bestimmten Zeitraum ab.
  • Externe Intelligence-Berichte importieren — Reichen Sie BitSight-, SecurityScorecard- oder Recorded-Future-Berichte mit create_bitsight_intelligence_report, create_security_scorecard_intelligence_report oder create_recorded_future_intelligence_report ein.
  • Webhooks konfigurieren — Erstellen, aktualisieren, löschen oder überprüfen Sie Webhook-Konfigurationen mit create_webhook_configuration, update_webhook_configuration und get_all_webhooks.

Dokumentation

VISO TRUST MCP-Server

Ein Model Context Protocol (MCP)-Server zur Integration der VISO TRUST API-Funktionen mit KI-Assistenten.

Gehosteter Remote-Server

VISO TRUST hostet eine verwaltete Instanz dieses MCP-Servers, sodass Sie nichts erstellen, ausführen oder selbst hosten müssen, um loszulegen:

https://mcp.visotrust.com/mcp

Verbinden Sie einen beliebigen MCP-Client über den Streamable HTTP-Transport mit diesem Endpunkt und authentifizieren Sie sich mit Ihrem VISO TRUST API-Token. Informationen zur Generierung eines API-Tokens finden Sie in der VISO TRUST Support-Dokumentation.

Beispiel für eine Client-Konfiguration:

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

Um den gehosteten Endpunkt mit MCP Inspector zu testen, führen Sie npx @modelcontextprotocol/inspector aus, setzen Sie Transport Type auf Streamable HTTP und verwenden Sie die obige URL.

Der Rest dieses Dokuments behandelt die eigenständige Ausführung des Servers (lokal oder in Ihrer eigenen Infrastruktur).

Voraussetzungen

  • Java 21+
  • Gradle
  • Docker (optional für containerisierte Bereitstellung)
  • MCP Inspector (optional zum Testen)

Konfiguration

VISO TRUST API-Konfiguration

Die folgenden Eigenschaften können für die VISO TRUST API konfiguriert werden:

  • visotrust.api.base-url: Die Basis-URL für die VISO TRUST API (Standard: http://localhost:8080)
  • visotrust.api.token: Ihr API-Token von der VISO TRUST-Plattform (erforderlich)
  • visotrust.api.timeout: API-Anforderungs-Timeout in Millisekunden (Standard: 30000)
  • visotrust.api.connect-timeout: API-Verbindungs-Timeout in Millisekunden (Standard: 5000)

Informationen zur Generierung eines API-Tokens für die Umgebungsvariable visotrust.api.token finden Sie in der VISO TRUST Support-Dokumentation.

Anwendungsprofile

Diese Anwendung unterstützt Spring Boot-Profile, um verschiedene Konfigurationen für unterschiedliche Bereitstellungsszenarien zu ermöglichen.

Remote-Profil

Das Profil remote ist für Remote-MCP-Unterstützung über den Streamable HTTP-Transport konzipiert. Dieses Profil führt den Server als Webanwendung aus, sodass er über HTTP mit Remote-Clients kommunizieren kann. (Streamable HTTP ersetzt den veralteten SSE-Transport; hier ist es im zustandslosen Modus konfiguriert.)

Wesentliche Unterschiede im Remote-Profil:

  • Läuft als Servlet-Webanwendung (Tomcat) auf Port 3001 anstelle von Standard-I/O
  • Stellt den MCP-Endpunkt unter POST /mcp bereit (Streamable HTTP)
  • Läuft im zustandslosen Modus – kein sitzungsbezogener Serverzustand, sodass er horizontal hinter einem Load Balancer ohne erforderliche Sitzungsaffinität skaliert werden kann
  • Optimierte Servereinstellungen für Remote-Client-Verbindungen
  • Erweiterte Protokollierung für verteiltes Debugging

Hinweis: Clients verbinden sich mit dem einzelnen Streamable HTTP-Endpunkt …/mcp. Die veralteten SSE-Endpunkte (/sse + /mcp/message) werden nicht mehr bereitgestellt.

So aktivieren Sie das Remote-Profil:

Bei direkter Ausführung mit Java:

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

Bei Ausführung mit Gradle:

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

Bei Verwendung von Docker:

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

Wann Sie das Remote-Profil verwenden sollten:

  • Bei der Bereitstellung des MCP-Servers auf einem Remote-Server oder in einer Cloud-Umgebung
  • Wenn Clients sich über Streamable HTTP statt direkt über stdio verbinden
  • Wenn Sie erweiterte Protokollierung und Überwachung für verteilte Bereitstellungen benötigen
  • Bei der Integration mit webbasierten KI-Assistenten, die sich über Streamable HTTP verbinden

Für die lokale Entwicklung und direkte stdio-Kommunikation verwenden Sie das Standardprofil (keine Profilangabe erforderlich).

Installation

Schnellinstallation

Klicken Sie auf eine der Schaltflächen unten, um den VISO MCP-Server in VS Code zu installieren:

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

Manuelle Einrichtung mit VS Code

Fügen Sie den folgenden JSON-Block zu Ihrer Benutzereinstellungsdatei (JSON) in VS Code hinzu. Sie können dies tun, indem Sie Strg + Umschalt + P drücken und Einstellungen: Benutzereinstellungen (JSON) öffnen eingeben.

{
  "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}"
        }
      }
    }
  }
}

Optional können Sie ein ähnliches Beispiel (d. h. ohne den mcp-Schlüssel) zu einer Datei namens .vscode/mcp.json in Ihrem Arbeitsbereich hinzufügen. Dadurch können Sie die Konfiguration mit anderen teilen.

{
  "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}"
      }
    }
  }
}

Verwendung mit Claude Desktop und anderen MCP-Clients

Docker-Konfiguration

{
    "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"
            }
        }
    }
}

Java-Konfiguration

{
    "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"
            }
        }
    }
}

Hinweis: Die Umgebungsvariable JAVA_TOOL_OPTIONS wird verwendet, um die JVM-Optionen für Remote-Debugging festzulegen. Adresse und Port können bei Bedarf geändert werden.

💻 Entwicklung

Docker-Setup

Docker-Image erstellen

docker build -t viso-mcp-server .

Docker-Container ausführen

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

Debugging

MCP Inspector installieren

npm -g install @modelcontextprotocol/inspector

MCP Inspector zum Testen ausführen

  1. MCP-Server-JAR-Datei erstellen
./gradlew bootJar
  1. MCP Inspector ausführen
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

Ersetzen Sie <version> durch die aktuelle Version des Projekts (z. B. 1.0.0 oder die Version des neuesten Release).

CI/CD-Pipeline

Dieses Projekt verwendet GitHub Actions für Continuous Integration und Deployment. Der Workflow umfasst die folgenden Jobs:

Lint

Überprüft die Codeformatierung mit Spotless:

./gradlew spotlessCheck

Build

Erstellt die Anwendung und erzeugt eine JAR-Datei:

./gradlew build

Publish

Wenn ein neues Release erstellt wird:

  1. Aktualisiert die Projektversion in build.gradle, um mit dem Release-Tag übereinzustimmen
  2. Lädt die JAR-Datei mit der Version aus dem Release-Tag in das GitHub-Release hoch
  3. Erstellt und pusht das Docker-Image zu Docker Hub mit Tags:
    • latest
    • Das Release-Tag (z. B. v1.0.0)
Erforderliche Secrets für die Veröffentlichung

Um die Docker Hub-Veröffentlichung zu aktivieren, fügen Sie diese Secrets zu Ihrem GitHub-Repository hinzu:

  • DOCKERHUB_USERNAME: Ihr Docker Hub-Benutzername
  • DOCKERHUB_TOKEN: Ihr Docker Hub-Zugriffstoken

🛠️ Werkzeuge

Dieser Abschnitt enthält die Dokumentation für die vom VISO MCP-Server bereitgestellten Werkzeuge. Jedes Werkzeug hat einen bestimmten Zweck, Eingabeparameter und ein Ausgabeformat.

Assessments

get_assessment - Ein Assessment anhand seiner ID abrufen

  • id: Assessment-ID (Zahl, erforderlich)

Gibt detaillierte Informationen zu einem bestimmten Assessment zurück.

get_assessment_summary - Die Zusammenfassung für ein Assessment anhand seiner ID abrufen

  • id: Assessment-ID (Zahl, erforderlich)

Gibt die Zusammenfassungsdetails für ein bestimmtes Assessment zurück.

create_assessment - Ein Assessment für eine bestehende Beziehung starten

  • relationshipId: Die ID der Beziehung, für die ein Assessment erstellt werden soll (Zahl, erforderlich)
  • recipientEmail: E-Mail-Adresse des Assessment-Empfängers (Zeichenkette, optional)
  • recipientFirstName: Vorname des Assessment-Empfängers (Zeichenkette, optional)
  • recipientLastName: Nachname des Assessment-Empfängers (Zeichenkette, optional)
  • publicDocumentUrls: URLs öffentlicher Dokumente, die in das Assessment aufgenommen werden sollen (Zeichenketten-Array, optional)
  • followupType: Art der Nachverfolgung (Zeichenketten-Enum, optional)
  • followupRiskThreshold: Risikostufenschwelle, die eine Nachverfolgung auslöst (Zeichenketten-Enum, optional)
  • followupTimeline: Zeitplan für Nachverfolgungsaktionen (Zeichenketten-Enum, optional)
  • collectionTimeline: Zeitplan für den Anbieter, um die Assessment-Einreichung abzuschließen (Zeichenketten-Enum, optional)
  • noVendorResponseAction: Aktion, die ausgeführt wird, wenn der Anbieter nicht antwortet (Zeichenketten-Enum, optional)
  • aiProcessingOnly: Ob nur mit KI ohne menschliche Überprüfung verarbeitet werden soll (boolesch, optional)
  • requestedAuditTypes: Für dieses Assessment angeforderte Audit-Typen (Zeichenketten-Array, optional)

Gibt die Details des erstellten Assessments zurück.

update_assessment_expiration_date - Die Frist aktualisieren, bis zu der der Anbieter seine Assessment-Antwort einreichen muss

  • id: Assessment-ID (Zahl, erforderlich)
  • expirationDate: Neues Ablaufdatum/-uhrzeit, ISO-8601 mit Offset; muss in der Zukunft liegen (Zeichenkette, erforderlich)

Gibt eine Bestätigungsmeldung zurück.

update_assessment_followup - Die Nachverfolgungskonfiguration für ein Assessment aktualisieren

  • id: Assessment-ID (Zahl, erforderlich)
  • followupType: Art der Nachverfolgung (Zeichenketten-Enum, erforderlich)
  • followupRiskThreshold: Risikoschwelle, bei oder oberhalb derer ein Nachverfolgungs-Assessment ausgelöst werden soll (Zeichenketten-Enum, optional)
  • followupTimeline: Zeitplan für die Nachverfolgung (Zeichenketten-Enum, optional)

Gibt eine Bestätigungsmeldung zurück.

Audit-Protokolle

get_user_audit_log_events - Benutzerbezogene Audit-Protokollereignisse für Ihre Organisation abrufen

  • start: Startdatum/-uhrzeit der Abfrage, ISO-8601 mit Offset (Zeichenkette, erforderlich)
  • end: Enddatum/-uhrzeit der Abfrage, ISO-8601 mit Offset (Zeichenkette, erforderlich)
  • eventTypes: Optionale Menge von Ereignistypen zum Filtern (z. B. USER_LOGGED_IN); leer lassen für alle (Zeichenketten-Array, optional)

Gibt eine Liste von Benutzer-Audit-Protokollereignissen zurück, begrenzt auf 500 Datensätze.

get_audit_log_events - Gefilterte Audit-Protokollereignisse abrufen (Benutzer-, Organisations-, Assessment- und Beziehungsereignisse)

  • start: Startdatum/-uhrzeit der Abfrage, ISO-8601 mit Offset (Zeichenkette, erforderlich)
  • end: Enddatum/-uhrzeit der Abfrage, ISO-8601 mit Offset (Zeichenkette, erforderlich)
  • eventTypes: Optionale Menge von Ereignistypen zum Filtern (z. B. ASSESSMENT_COMPLETED, RELATIONSHIP_CREATED); leer lassen für alle (Zeichenketten-Array, optional)

Gibt polymorphe Audit-Protokollereignisdatensätze zurück. Jedes Element hat mindestens auditEventType und dateTime.

Business Cases

get_all_business_cases - Alle verfügbaren Business Cases für Ihre Organisation abrufen

Keine Parameter erforderlich.

Gibt eine Liste aller für Ihre Organisation verfügbaren Business Cases zurück.

Datentypen

get_all_datatypes - Alle verfügbaren Datentypen für Ihre Organisation abrufen

Keine Parameter erforderlich.

Gibt eine Liste aller für Ihre Organisation verfügbaren Datentypen zurück.

Anbieterverzeichnis

search_vendor_directory - Einen Anbieter im VISO TRUST-Anbieterverzeichnis anhand von URL oder Domain suchen

  • urlOrDomain: Die zu suchende URL oder der Domainname, z. B. example.com (Zeichenkette, erforderlich)

Gibt grundlegende Anbietermetadaten zurück (Name, Homepage, Beschreibung, Favicon, bekannte Domains).

Beziehungen

get_all_relationships - Eine Liste aller Beziehungen und deren Assessment-Details abrufen

Keine Parameter erforderlich.

Gibt Informationen zu Drittanbietern zurück, einschließlich deren Assessment-Status, Risikostufen und Kontaktdaten.

get_relationship_by_id - Eine bestimmte Beziehung und deren Assessment-Details anhand der ID abrufen

  • id: Beziehungs-ID (Zahl, erforderlich)

Gibt detaillierte Informationen zu einem Drittanbieter zurück, einschließlich Assessment-Status, Risikostufen und Kontaktdaten.

get_relationship_assessment_history - Den Assessment-Verlauf für eine Beziehung abrufen

  • id: Beziehungs-ID (Zahl, erforderlich)

Gibt eine Liste der mit der angegebenen Beziehung verknüpften Assessments zurück.

create_relationship - Eine neue Beziehung mit einem Drittanbieter erstellen

  • name: Name der Beziehung/des Anbieters (Zeichenkette, erforderlich)
  • homepage: Homepage-URL des Anbieters (Zeichenkette, erforderlich)
  • businessOwnerEmail: E-Mail-Adresse des Geschäftsinhabers (Zeichenkette, erforderlich)
  • businessOwnerFirstName: Vorname des Geschäftsinhabers (Zeichenkette, optional)
  • businessOwnerLastName: Nachname des Geschäftsinhabers (Zeichenkette, optional)
  • description: Beschreibung der Beziehung/des Anbieters (Zeichenkette, optional)
  • contextTypes: Liste der Geschäftskontexttypen für diese Beziehung (Objekt-Array, optional)
  • dataTypes: Liste der in dieser Beziehung verarbeiteten Datentypen (Objekt-Array, optional)
  • tags: Liste von Tags zur Kategorisierung dieser Beziehung (Zeichenketten-Array, optional)
  • thirdPartyContact: Kontaktdaten des Vertreters des Drittanbieters (Objekt, optional)

Gibt die Details der erstellten Beziehung zurück.

create_relationship_by_domain - Eine neue Beziehung nur anhand der Anbieterdomain erstellen

  • domain: Domain des Anbieters, z. B. visotrust.com (Zeichenkette, erforderlich)
  • vendorName: Name des Anbieters (Zeichenkette, erforderlich)
  • product: Vom Anbieter angebotenes Produkt (Zeichenkette, optional)
  • description: Beschreibung der Anbieterbeziehung (Zeichenkette, optional)

Gibt die Details der erstellten Beziehung zurück.

update_relationship – Eine bestehende Beziehung zu einem Drittanbieter aktualisieren

  • id: Beziehungs-ID (Zahl, erforderlich)
  • name: Name der Beziehung/des Anbieters (Zeichenkette, erforderlich)
  • homepage: Homepage-URL des Anbieters (Zeichenkette, optional)
  • description: Beschreibung der Beziehung/des Anbieters (Zeichenkette, optional)
  • contextTypes: Liste der Geschäftskontexttypen (Objekt[], optional)
  • dataTypes: Liste der in dieser Beziehung verarbeiteten Datentypen (Objekt[], optional)
  • businessOwnerEmail: E-Mail-Adresse des Geschäftsinhabers (Zeichenkette, optional)
  • businessOwnerFirstName: Vorname des Geschäftsinhabers (Zeichenkette, optional)
  • businessOwnerLastName: Nachname des Geschäftsinhabers (Zeichenkette, optional)
  • tags: Liste von Tags (Zeichenkette[], optional)

Gibt die aktualisierten Beziehungsdetails zurück.

partially_update_relationship – Eine bestehende Beziehung teilweise aktualisieren

Akzeptiert dieselben Felder wie update_relationship. Nur die in der Anfrage angegebenen Felder werden geändert; andere Felder bleiben unverändert.

Gibt die aktualisierten Beziehungsdetails zurück.

search_relationships – Nach Beziehungen anhand von Domainnamen oder Anbieternamen suchen

  • domains: Liste der zu suchenden Domainnamen (Zeichenkette[], erforderlich)
  • name: Name des zu suchenden Anbieters/der Beziehung (Zeichenkette, erforderlich)

Gibt eine Liste übereinstimmender Beziehungen mit ihren Bewertungsdetails zurück.

create_tags – Neue Tags zur Kategorisierung von Beziehungen erstellen

  • tags: Liste der zu erstellenden Tag-Namen (Zeichenkette[], erforderlich)

Gibt eine Liste aller Tags einschließlich der neu erstellten zurück.

update_third_party_contact – Die Kontaktdaten für einen Drittanbieter aktualisieren

  • relationshipId: Beziehungs-ID (Zahl, erforderlich)
  • email: Kontakt-E-Mail (Zeichenkette, erforderlich)
  • firstName: Vorname des Kontakts (Zeichenkette, erforderlich)
  • lastName: Nachname des Kontakts (Zeichenkette, erforderlich)

Gibt die aktualisierten Beziehungsdetails zurück.

onboard_relationship – Eine Beziehung onboarden, optional mit Genehmigungszusammenfassung und Lifecycle-Management-Einstellungen

  • id: Beziehungs-ID (Zahl, erforderlich)
  • approvalSummary: Optionale Genehmigungszusammenfassung, die beim Onboarding aufgezeichnet wird (Zeichenkette, optional)
  • lifecycleManagementUpdateRequest: Optionale Lifecycle-Management-Einstellungen (Objekt, optional)
    • artifactUpdateSettings.artifactUpdateType: Artefakt-Aktualisierungstyp (Zeichenketten-Enum)
    • recertificationSettings.recertificationType: Rezertifizierungstyp (Zeichenketten-Enum)
    • recertificationSettings.recertificationDate: Datum/Uhrzeit der nächsten Rezertifizierung, ISO-8601 mit Offset (Zeichenkette)
    • recertificationSettings.reviewFrequency: THREE_YEARS, TWO_YEARS, ANNUAL, SEMIANNUAL oder QUARTERLY (Zeichenketten-Enum)

Gibt die onboardeten Beziehungsdetails zurück.

offboard_relationship – Eine Beziehung offboarden

  • id: Beziehungs-ID (Zahl, erforderlich)

Gibt die offboardeten Beziehungsdetails zurück.

archive_relationship – Eine Beziehung archivieren

  • id: Beziehungs-ID (Zahl, erforderlich)

Gibt die archivierten Beziehungsdetails zurück.

Webhooks

get_all_webhooks – Alle Webhooks abrufen

Keine Parameter erforderlich.

Gibt eine Liste aller Webhook-Konfigurationen zurück.

get_webhook – Eine Webhook-Konfiguration anhand der ID abrufen

  • id: Webhook-ID (Zahl, erforderlich)

Gibt Details einer bestimmten Webhook-Konfiguration zurück.

create_webhook_configuration – Eine Webhook-Konfiguration erstellen

  • request: Parameter für die Webhook-Erstellung (Objekt, erforderlich)
    • url: Webhook-URL (Zeichenkette, erforderlich)
    • secret: Webhook-Geheimnis (Zeichenkette, erforderlich)
    • eventTypes: Arten von Ereignissen, die den Webhook auslösen (Zeichenkette[], erforderlich)
    • serviceType: Art des Dienstes für den Webhook (Zeichenkette, erforderlich)

Gibt die erstellte Webhook-Konfiguration zurück.

update_webhook_configuration – Eine Webhook-Konfiguration aktualisieren

  • request: Parameter für die Webhook-Aktualisierung (Objekt, erforderlich)
    • id: Webhook-ID (Zahl, erforderlich)
    • url: Webhook-URL (Zeichenkette, optional)
    • secret: Webhook-Geheimnis (Zeichenkette, optional)
    • eventTypes: Arten von Ereignissen, die den Webhook auslösen (Zeichenkette[], optional)
    • serviceType: Art des Dienstes für den Webhook (Zeichenkette, optional)

Gibt die aktualisierte Webhook-Konfiguration zurück.

delete_webhook_configuration – Eine Webhook-Konfiguration löschen

  • id: Webhook-ID (Zahl, erforderlich)

Löscht die angegebene Webhook-Konfiguration.

Intelligence-Berichte

create_bitsight_intelligence_report – Einen neuen BitSight-Intelligence-Bericht erstellen

  • request: BitSight-Berichtsparameter (Objekt, erforderlich)
    • vendorDomain: Der primäre Domainname des Anbieters (Zeichenkette, erforderlich)
    • reportDate: Datum/Uhrzeit der Berichtserstellung (ISO-8601-Zeichenkette, erforderlich)
    • link: Optionaler Link zur Benutzeroberfläche des Anbieters (Zeichenkette, optional)
    • guid: BitSight-GUID für die Entität (Zeichenkette, erforderlich)
    • customId: Benutzerdefinierte Kennung von BitSight (Zeichenkette, optional)
    • name: Anzeigename der BitSight-Entität (Zeichenkette, optional)
    • description: Beschreibung der BitSight-Entität (Zeichenkette, optional)
    • primaryDomain: Primäre Domain für die BitSight-Entität (Zeichenkette, optional)
    • ratingRange: BitSight-Bewertungsbereich (Zeichenkette, optional)
    • ratingColor: BitSight-Bewertungsfarbe (Zeichenkette, optional)
    • confidence: Konfidenzniveau der BitSight-Bewertung (Zeichenkette, optional)

Gibt den erstellten Intelligence-Bericht zurück.

create_security_scorecard_intelligence_report – Einen neuen SecurityScorecard-Intelligence-Bericht erstellen

  • request: SecurityScorecard-Berichtsparameter (Objekt, erforderlich)
    • vendorDomain: Der primäre Domainname des Anbieters (Zeichenkette, erforderlich)
    • reportDate: Datum/Uhrzeit der Berichtserstellung (ISO-8601-Zeichenkette, erforderlich)
    • link: Optionaler Link zur Benutzeroberfläche des Anbieters (Zeichenkette, optional)
    • grade: SecurityScorecard-Buchstabennote (Zeichenkette, erforderlich)
    • domain: Mit der Scorecard-Entität verknüpfte Domain (Zeichenkette, optional)
    • score: Numerische Punktzahl von SecurityScorecard (Zahl, optional)

Gibt den erstellten Intelligence-Bericht zurück.

create_recorded_future_intelligence_report – Einen neuen Recorded Future-Intelligence-Bericht erstellen

  • request: Recorded Future-Berichtsparameter (Objekt, erforderlich)
    • vendorDomain: Der primäre Domainname des Anbieters (Zeichenkette, erforderlich)
    • reportDate: Datum/Uhrzeit der Berichtserstellung (ISO-8601-Zeichenkette, erforderlich)
    • entityType: Recorded Future-Entitätstyp, z. B. Company (Zeichenkette, erforderlich)
    • entity: Recorded Future-Entitätskennung (Zeichenkette, erforderlich)
    • riskScore: Numerische Risikobewertung (Zahl, erforderlich)
    • riskLevel: Risikostufenbezeichnung, z. B. Critical/High/Medium/Low (Zeichenkette, erforderlich)
    • link: Optionaler Link zum Bericht in der Benutzeroberfläche des Anbieters (Zeichenkette, optional)
    • firstSeen: Frühestes beobachtetes Datum für die Entität, ISO 8601 (Zeichenkette, optional)
    • lastSeen: Letztes beobachtetes Datum für die Entität, ISO 8601 (Zeichenkette, optional)
    • triggeredRuleCount: Anzahl der ausgelösten Recorded Future-Regeln (Zahl, optional)
    • maxRuleCount: Maximale Anzahl der ausgewerteten Recorded Future-Regeln (Zahl, optional)
    • summary: Optionaler Zusammenfassungstext von Recorded Future (Zeichenkette, optional)
    • criticalityLabel: Recorded Future-Kritikalitätsbezeichnung für die Entität (Zeichenkette, optional)

Gibt den erstellten Intelligence-Bericht zurück.

get_intelligence_reports_by_vendor – Alle Intelligence-Berichte für einen Anbieter abrufen

  • vendorDomain: Der primäre Domainname des Anbieters (Zeichenkette, erforderlich)

Gibt eine Liste der Intelligence-Berichte für den angegebenen Anbieter zurück.

get_latest_intelligence_report – Den neuesten Intelligence-Bericht für einen Anbieter von einer bestimmten Quelle abrufen

  • vendorDomain: Der primäre Domainname des Anbieters (Zeichenkette, erforderlich)
  • source: Intelligence-Anbieter (Zeichenketten-Enum: BITSIGHT, SECURITY_SCORECARD oder RECORDED_FUTURE, erforderlich)

Gibt den neuesten Intelligence-Bericht für den angegebenen Anbieter und die Quelle zurück.

Benutzer

get_all_users – Alle Benutzer in Ihrer Organisation abrufen

  • page: Abzurufende Ergebnisseite (Zahl, optional; Standard 0)
  • size: Anzahl der Datensätze pro Seite (Zahl, optional; Standard 20)
  • sort: Sortierkriterien im Format: Eigenschaft(,asc|desc) (Zeichenkette, optional)

Gibt eine paginierte Liste von Benutzern zurück.

get_user_by_email – Einen Benutzer anhand der E-Mail-Adresse abrufen

  • email: E-Mail-Adresse des Benutzers (Zeichenkette, erforderlich)

Gibt die Benutzerdetails zurück.

create_user – Einen neuen Benutzer erstellen

  • request: Parameter für die Benutzererstellung (Objekt, erforderlich)
    • email: E-Mail-Adresse des neuen Benutzers (Zeichenkette, erforderlich)
    • firstName: Vorname des neuen Benutzers (Zeichenkette, erforderlich)
    • lastName: Nachname des neuen Benutzers (Zeichenkette, erforderlich)

Gibt den erstellten Benutzer zurück.

Code-Formatierung

Dieses Projekt verwendet Spotless mit Google Java Format zur Code-Formatierung. Ein Pre-Commit-Hook wird automatisch eingerichtet, um einen konsistenten Codestil sicherzustellen.

Einrichtung

Nach dem Klonen des Repositorys wird der Pre-Commit-Hook automatisch eingerichtet, wenn Sie einen beliebigen Gradle-Befehl ausführen.

Manuelle Formatierung

Um alle Dateien manuell zu formatieren:

./gradlew spotlessApply

Um zu prüfen, ob die Dateien korrekt formatiert sind:

./gradlew spotlessCheck

Wenn der Pre-Commit-Hook Ihren Commit aufgrund von Formatierungsproblemen ablehnt, führen Sie einfach ./gradlew spotlessApply aus, um die Formatierung zu korrigieren, und versuchen Sie dann erneut zu committen.

Lizenz

Dieses Projekt ist unter der MIT-Lizenz lizenziert – siehe die LICENSE-Datei für Details.