VISO TRUST

官方

直接透過您的 AI 助手存取和管理您的 VISO TRUST 第三方風險計劃。

你可以用 VISO TRUST MCP 做什麼?

  • 查詢供應商評估 — 依 ID 擷取特定評估,包括以 HTML 或 Markdown 格式呈現的 AI 生成摘要。
  • 建立及管理評估 — 為現有關係啟動評估、更新其到期日,或調整後續追蹤設定。
  • 搜尋供應商關係 — 依標籤、網域、狀態、風險等級、分數範圍、業務單位及日期篩選關係。
  • 供應商入駐或退場 — 為關係辦理入駐,並設定核准摘要及生命週期設定;或將其退場並封存。
  • 檢視稽核記錄 — 在指定日期範圍內查詢使用者、組織、評估及關係的稽核事件。
  • 管理情報報告 — 為供應商網域建立、更新或擷取 BitSight、SecurityScorecard 及 Recorded Future 報告。

文件

VISO TRUST MCP Server

用於將 VISO TRUST API 功能整合至 AI 助理的 Model Context Protocol (MCP) 伺服器。

託管遠端伺服器

VISO TRUST 託管此 MCP 伺服器的受管理執行個體,因此您無需建置、執行或自行託管任何內容即可開始使用:

https://mcp.visotrust.com/mcp

使用 Streamable HTTP 傳輸將任何 MCP 用戶端連線至此端點,並使用您的 VISO TRUST API 權杖進行驗證。如需瞭解如何產生 API 權杖,請參閱 VISO TRUST 支援文件。

用戶端設定範例:

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

若要使用 MCP Inspector 測試託管端點,請執行 npx @modelcontextprotocol/inspector,將 Transport Type 設為 Streamable HTTP,並使用上方的 URL。

本文其餘部分將說明如何自行執行伺服器(在本機或您自己的基礎架構中)。

需求

  • Java 21+
  • Gradle
  • Docker(容器化部署時選用)
  • MCP Inspector(測試時選用)

設定

VISO TRUST API 設定

可為 VISO TRUST API 設定下列屬性:

  • visotrust.api.base-url:VISO TRUST API 的基礎 URL(預設值:http://localhost:8080)
  • visotrust.api.token:您在 VISO TRUST 平台上的 API 權杖(必填)
  • visotrust.api.timeout:API 請求逾時時間(毫秒,預設值:30000)
  • visotrust.api.connect-timeout:API 連線逾時時間(毫秒,預設值:5000)

如需瞭解如何為 visotrust.api.token 環境變數產生 API 權杖,請參閱 VISO TRUST 支援文件。

應用程式設定檔

此應用程式支援 Spring Boot 設定檔,可針對不同的部署情境啟用不同設定。

Remote 設定檔

remote 設定檔專為透過 Streamable HTTP 傳輸提供遠端 MCP 支援而設計。此設定檔會以 Web 應用程式的形式執行伺服器,使其能透過 HTTP 與遠端用戶端通訊。(Streamable HTTP 取代已棄用的 SSE 傳輸;此處設定為無狀態模式。)

Remote 設定檔的主要差異:

  • 以 servlet Web 應用程式(Tomcat)形式在連接埠 3001 上執行,而非使用標準 I/O
  • 在 POST /mcp 公開 MCP 端點(Streamable HTTP)
  • 以無狀態模式執行 — 不保留每個工作階段的伺服器狀態,因此可在負載平衡器後方水平擴充,且不需要工作階段親和性
  • 為遠端用戶端連線最佳化的伺服器設定
  • 強化記錄功能,方便進行分散式偵錯

注意: 用戶端會連線至單一 Streamable HTTP 端點 …/mcp。舊版 SSE 端點(/sse + /mcp/message)已不再提供服務。

啟用 Remote 設定檔:

直接使用 Java 執行時:

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

使用 Gradle 執行時:

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

使用 Docker 時:

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

適用 Remote 設定檔的情況:

  • 將 MCP 伺服器部署至遠端伺服器或雲端環境時
  • 用戶端將透過 Streamable HTTP 而非直接使用 stdio 連線時
  • 分散式部署需要強化記錄與監控時
  • 與透過 Streamable HTTP 連線的網頁型 AI 助理整合時

若要進行本機開發並直接透過 stdio 通訊,請使用預設設定檔(不需要指定設定檔)。

安裝

快速安裝

按一下下方其中一個按鈕,在 VS Code 中安裝 VISO MCP Server:

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

在 VS Code 中手動設定

將下列 JSON 區塊新增至 VS Code 的 User Settings (JSON) 檔案。您可以按 Ctrl + Shift + P,然後輸入 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}"
        }
      }
    }
  }
}

您也可以選擇將類似的範例(即不含 mcp 索引鍵)新增至工作區中名為 .vscode/mcp.json 的檔案。這樣即可與其他人共用設定。

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

搭配 Claude Desktop 和其他 MCP 用戶端使用

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

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

注意:JAVA_TOOL_OPTIONS 環境變數用於設定遠端偵錯的 JVM 選項。您可以視需要變更位址和連接埠。

💻 開發

Docker 設定

建置 Docker 映像

docker build -t viso-mcp-server .

執行 Docker 容器

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

偵錯

安裝 MCP Inspector

npm -g install @modelcontextprotocol/inspector

執行 MCP Inspector 進行測試

  1. 建置 MCP Server Jar 檔案
./gradlew bootJar
  1. 執行 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

將 <version> 替換為專案目前的版本(例如 1.0.0 或最新版本的版本號)。

CI/CD 管線

此專案使用 GitHub Actions 進行持續整合與部署。工作流程包含下列工作:

Lint

使用 Spotless 檢查程式碼格式:

./gradlew spotlessCheck

Build

建置應用程式並建立 JAR 檔案:

./gradlew build

Publish

建立新版本時:

  1. 更新 build.gradle 中的專案版本,使其符合版本標籤
  2. 將 JAR 檔案上傳至 GitHub 版本發佈項目,並使用版本標籤中的版本號
  3. 建置 Docker 映像,並推送至 Docker Hub,使用下列標籤:
    • latest
    • 版本標籤(例如 v1.0.0)
發佈所需的 Secrets

若要啟用 Docker Hub 發佈功能,請將下列 secrets 新增至您的 GitHub 儲存庫:

  • DOCKERHUB_USERNAME:您的 Docker Hub 使用者名稱
  • DOCKERHUB_TOKEN:您的 Docker Hub 存取權杖

🛠️ 工具

本節說明 VISO MCP Server 提供的工具。每個工具都有特定用途、輸入參數和輸出格式。

評估

get_assessment - 依 ID 取得評估

  • id:評估 ID(數字,必填)

傳回特定評估的詳細資訊。

get_assessment_summary - 依 ID 取得評估摘要

  • id:評估 ID(數字,必填)
  • format:HTML(預設值)或 MARKDOWN(字串,選填)

傳回摘要、其 version,以及是否已 edited。

update_assessment_summary - 替換已完成評估的 AI 產生摘要文字

  • id:評估 ID(數字,必填)
  • summary:編輯後的摘要(字串,必填)
  • format:HTML(預設值)或 MARKDOWN(字串,選填)
  • version:來自 get_assessment_summary 的 version;若摘要自該版本後有所變更,更新將遭拒(字串,選填)

以提交時使用的格式傳回更新後的摘要。

create_assessment - 為現有關係啟動評估

  • relationshipId:要建立評估之關係的 ID(數字,必填)
  • recipientEmail:評估對象的電子郵件地址(字串,選填)
  • recipientFirstName:評估對象的名字(字串,選填)
  • recipientLastName:評估對象的姓氏(字串,選填)
  • publicDocumentUrls:要納入評估的公開文件 URL(字串[],選填)
  • followupType:後續追蹤類型(字串列舉,選填)
  • followupRiskThreshold:觸發後續追蹤的風險等級門檻(字串列舉,選填)
  • followupTimeline:後續追蹤作業的時程(字串列舉,選填)
  • collectionTimeline:供廠商完成評估提交的時程(字串列舉,選填)
  • noVendorResponseAction:廠商未回覆時採取的動作(字串列舉,選填)
  • aiProcessingOnly:是否僅使用 AI 處理而不進行人工審查(布林值,選填)
  • requestedAuditTypes:此評估要求的稽核類型(字串[],選填)

傳回已建立評估的詳細資訊。

update_assessment_expiration_date - 更新廠商提交評估回覆的期限

  • id:評估 ID(數字,必填)
  • expirationDate:新的到期日期/時間,採用含時區偏移的 ISO-8601 格式;必須是未來時間(字串,必填)

傳回確認訊息。

update_assessment_followup - 更新評估的後續追蹤設定

  • id:評估 ID(數字,必填)
  • followupType:後續追蹤類型(字串列舉,必填)
  • followupRiskThreshold:觸發後續評估的風險門檻(字串列舉,選填)
  • followupTimeline:後續追蹤時程(字串列舉,選填)

傳回確認訊息。

稽核記錄

get_user_audit_log_events - 取得組織中使用者範圍的稽核記錄事件

  • start:查詢的開始日期/時間,採用含時區偏移的 ISO-8601 格式(字串,必填)
  • end:查詢的結束日期/時間,採用含時區偏移的 ISO-8601 格式(字串,必填)
  • eventTypes:用於篩選的選用事件類型集合(例如 USER_LOGGED_IN);留空則包含全部(字串[],選填)

傳回使用者稽核記錄事件清單,最多 500 筆。

get_audit_log_events - 取得篩選後的稽核記錄事件(使用者、組織、評估和關係事件)

  • start:查詢的開始日期/時間,採用含時區偏移的 ISO-8601 格式(字串,必填)
  • end:查詢的結束日期/時間,採用含時區偏移的 ISO-8601 格式(字串,必填)
  • eventTypes:用於篩選的選用事件類型集合(例如 ASSESSMENT_COMPLETED、RELATIONSHIP_CREATED);留空則包含全部(字串[],選填)

傳回多型稽核記錄事件。每個項目至少包含 auditEventType 和 dateTime。

業務單位

get_all_business_units - 取得組織的所有業務單位,並依名稱排序

傳回每個業務單位的 id(可用作 search_relationships 中的 businessUnitIds 篩選條件)和 name(可在 create_user 中用作 businessUnit)。

業務案例

get_all_business_cases - 取得組織所有可用的業務案例

不需要參數。

傳回組織所有可用業務案例的清單。

資料類型

get_all_datatypes - 取得組織所有可用的資料類型

不需要參數。

傳回組織所有可用資料類型的清單。

廠商目錄

search_vendor_directory - 依 URL 或網域查詢 VISO TRUST 廠商目錄中的廠商

  • urlOrDomain:要搜尋的 URL 或網域名稱,例如 example.com(字串,必填)

傳回基本廠商中繼資料(名稱、首頁、描述、網站圖示、已知網域)。

關係

get_all_relationships - 取得所有關係及其評估詳細資訊清單

不需要參數。

傳回第三方廠商的相關資訊,包括其評估狀態、風險等級和聯絡方式。

get_relationship_by_id - 依 ID 取得特定關係及其評估詳細資訊

  • id:關係 ID(數字,必填)

傳回第三方廠商的詳細資訊,包括評估狀態、風險等級和聯絡方式。

get_relationship_assessment_history - 取得關係的評估歷程

  • id:關係 ID(數字,必填)

傳回與指定關係相關的評估清單。

create_relationship - 建立與第三方廠商的新關係

  • name:關係/廠商名稱(字串,必填)
  • homepage:廠商首頁 URL(字串,必填)
  • businessOwnerEmail:業務負責人的電子郵件地址(字串,必填)
  • businessOwnerFirstName:業務負責人的名字(字串,選填)
  • businessOwnerLastName:業務負責人的姓氏(字串,選填)
  • description:關係/廠商的描述(字串,選填)
  • contextTypes:此關係的業務情境類型清單(object[],選填)
  • dataTypes:此關係中處理的資料類型清單(object[],選填)
  • tags:用於分類此關係的標籤清單(字串[],選填)
  • thirdPartyContact:第三方廠商代表的聯絡資訊(object,選填)

傳回已建立關係的詳細資訊。

create_relationship_by_domain - 僅使用供應商網域建立新的關係

  • domain: 供應商的網域,例如 visotrust.com(字串,必填)
  • vendorName: 供應商名稱(字串,必填)
  • product: 供應商提供的產品(字串,選填)
  • description: 供應商關係的描述(字串,選填)

傳回已建立的關係詳細資料。

update_relationship - 更新與第三方供應商的現有關係

  • id: 關係 ID(數字,必填)
  • name: 關係/供應商名稱(字串,必填)
  • homepage: 供應商首頁 URL(字串,選填)
  • description: 關係/供應商的描述(字串,選填)
  • contextTypes: 業務情境類型清單(物件[],選填)
  • dataTypes: 此關係中處理的資料類型清單(物件[],選填)
  • businessOwnerEmail: 業務負責人的電子郵件地址(字串,選填)
  • businessOwnerFirstName: 業務負責人的名字(字串,選填)
  • businessOwnerLastName: 業務負責人的姓氏(字串,選填)
  • tags: 標籤清單(字串[],選填)

傳回已更新的關係詳細資料。

partially_update_relationship - 部分更新現有關係

接受與 update_relationship 相同的欄位。只會變更請求中提供的欄位;其他欄位維持不變。

傳回已更新的關係詳細資料。

search_relationships - 依篩選條件搜尋關係

呼叫 POST /api/v1/relationships/search。所有篩選條件皆為選填;篩選條件之間以 AND 組合,同一清單篩選條件中的值則以 OR 組合。

  • request: 搜尋篩選條件(物件,選填)
    • tags: 標籤名稱,須與 VISO TRUST 中顯示的完全一致(字串[],選填)
    • domains: 供應商網域名稱,例如 example.com(字串[],選填)
    • name: 完全相符的關係名稱(字串,選填)
    • externalId: 完全相符的外部 ID(字串,選填)
    • statuses: 關係狀態 — NOT_ONBOARDED、ONBOARDED、ARCHIVED(字串[],選填)
    • assessmentStatuses: 最新評估狀態(字串[],選填)
    • riskAcceptanceStatuses: RISK_ACCEPTED、REVIEW_NEEDED、REMEDIATION_REQUESTED(字串[],選填)
    • inherentRiskLevels / residualRiskLevels: NO_CONTEXT、LOW、MEDIUM、HIGH、EXTREME(字串[],選填)
    • minScore / maxScore: 分數範圍,包含端點(數字,選填)
    • businessUnitIds: 來自 get_all_business_units 的業務單位 ID(數字[],選填)
    • businessOwnerIds / creatorIds: 來自 get_all_users 的使用者 ID(數字[],選填)
    • createdAfter / createdBefore, onboardedAfter / onboardedBefore, recertificationAfter / recertificationBefore, assessmentCompletedAfter / assessmentCompletedBefore: ISO-8601 日期時間(字串,選填)
  • page: 從零開始的頁碼(數字,選填,預設值 0)
  • size: 頁面大小(數字,選填,預設值 100,最大值 500)
  • sort: 排序順序,格式為 property,asc|desc;屬性為 name、externalId、score、createdDate、onboardedDate、recertificationDate(字串[],選填)

傳回 totalCount、page、size、hasMore 以及符合條件的 relationships 頁面。

create_tags - 建立用於分類關係的新標籤

  • tags: 要建立的標籤名稱清單(字串[],必填)

傳回包含新建立標籤在內的所有標籤清單。

update_third_party_contact - 更新第三方供應商的聯絡資料

  • relationshipId: 關係 ID(數字,必填)
  • email: 聯絡電子郵件(字串,必填)
  • firstName: 聯絡人的名字(字串,必填)
  • lastName: 聯絡人的姓氏(字串,必填)

傳回已更新的關係詳細資料。

onboard_relationship - 將關係納入管理,可選擇提供核准摘要和生命週期管理設定

  • id: 關係 ID(數字,必填)
  • approvalSummary: 納入管理時記錄的選填核准摘要(字串,選填)
  • lifecycleManagementUpdateRequest: 選填的生命週期管理設定(物件,選填)
    • artifactUpdateSettings.artifactUpdateType: 成品更新類型(字串列舉)
    • recertificationSettings.recertificationType: 重新認證類型(字串列舉)
    • recertificationSettings.recertificationDate: 下次重新認證的日期/時間,採用含時區偏移的 ISO-8601 格式(字串)
    • recertificationSettings.reviewFrequency: THREE_YEARS、TWO_YEARS、ANNUAL、SEMIANNUAL 或 QUARTERLY(字串列舉)

傳回已納入管理的關係詳細資料。

offboard_relationship - 終止管理關係

  • id: 關係 ID(數字,必填)

傳回已終止管理的關係詳細資料。

accept_relationship_risk - 接受關係的風險

  • id: 關係 ID(數字,必填)
  • request:(物件,選填)
    • riskReviewNote: 說明此決策的備註(字串,選填)
    • inherentRiskOverride / residualRiskOverride: LOW、MEDIUM、HIGH 或 EXTREME;兩者必須同時提供或都不提供(字串,選填)

傳回已更新的關係。

get_relationship_detections - 取得關係證據中發現的偵測結果

  • id: 關係 ID(數字,必填)
  • detectionTypes: NORMAL、SUBSERVICE、SHARED_RESPONSIBILITY_MODEL、EXCEPTION、CUEC、SUBPROCESSOR;預設為全部,但不包含 NORMAL(字串[],選填)
  • controlDomainTypes: 要包含的控制領域類型;預設為全部(字串[],選填)
  • assessmentId: 此關係已完成的評估,或最新進行中的評估(數字,選填)
  • includeQuestionnaireAnswers: 是否包含補充問卷偵測結果所依據的答案(布林值,選填)
  • afterId: 上一頁的 nextAfterId(數字,選填)
  • size: 每頁偵測結果數量,介於 1 到 500(數字,選填,預設值 100)

傳回一頁偵測結果;只要 nextAfterId 不為 null,就繼續讀取。

get_risk_advisories_by_relationship - 取得關係供應商的風險公告

  • id: 關係 ID(數字,必填)

archive_relationship - 封存關係

  • id: 關係 ID(數字,必填)

傳回已封存的關係詳細資料。

Webhooks

get_all_webhooks - 取得所有 Webhook

不需要參數。

傳回所有 Webhook 設定的清單。

get_webhook - 依 ID 取得 Webhook 設定

  • id: Webhook ID(數字,必填)

傳回特定 Webhook 設定的詳細資料。

create_webhook_configuration - 建立 Webhook 設定

  • request: Webhook 建立參數(物件,必填)
    • url: Webhook URL(字串,必填)
    • secret: Webhook 密鑰(字串,必填)
    • eventTypes: 觸發 Webhook 的事件類型(字串[],必填)
    • serviceType: Webhook 的服務類型(字串,必填)

傳回已建立的 Webhook 設定。

update_webhook_configuration - 更新 Webhook 設定

  • request: Webhook 更新參數(物件,必填)
    • id: Webhook ID(數字,必填)
    • url: Webhook URL(字串,選填)
    • secret: Webhook 密鑰(字串,選填)
    • eventTypes: 觸發 Webhook 的事件類型(字串[],選填)
    • serviceType: Webhook 的服務類型(字串,選填)

傳回已更新的 Webhook 設定。

delete_webhook_configuration - 刪除 Webhook 設定

  • id: Webhook ID(數字,必填)

刪除指定的 Webhook 設定。

情資報告

create_bitsight_intelligence_report - 建立新的 BitSight 情資報告

  • request: BitSight 報告參數(物件,必填)
    • vendorDomain: 供應商的主要網域名稱(字串,必填)
    • reportDate: 報告產生的日期/時間(ISO 8601 字串,必填)
    • link: 供應商 UI 的選填連結(字串,選填)
    • guid: 實體的 BitSight GUID(字串,必填)
    • customId: BitSight 的自訂識別碼(字串,選填)
    • name: BitSight 實體的顯示名稱(字串,選填)
    • description: BitSight 實體的描述(字串,選填)
    • primaryDomain: BitSight 實體的主要網域(字串,選填)
    • ratingRange: BitSight 評級範圍(字串,選填)
    • ratingColor: BitSight 評級顏色(字串,選填)
    • confidence: BitSight 評級的信賴程度(字串,選填)

傳回已建立的情資報告。

create_security_scorecard_intelligence_report - 建立新的 SecurityScorecard 情資報告

  • request: SecurityScorecard 報告參數(物件,必填)
    • vendorDomain: 供應商的主要網域名稱(字串,必填)
    • reportDate: 報告產生的日期/時間(ISO 8601 字串,必填)
    • link: 供應商 UI 的選填連結(字串,選填)
    • grade: SecurityScorecard 字母評級(字串,必填)
    • domain: 與評分卡實體相關聯的網域(字串,選填)
    • score: SecurityScorecard 的數值分數(數字,選填)

傳回已建立的情資報告。

create_recorded_future_intelligence_report - 建立新的 Recorded Future 情資報告

  • request: Recorded Future 報告參數(物件,必填)
    • vendorDomain: 供應商的主要網域名稱(字串,必填)
    • reportDate: 報告產生的日期/時間(ISO 8601 字串,必填)
    • entityType: Recorded Future 實體類型,例如 Company(字串,必填)
    • entity: Recorded Future 實體識別碼(字串,必填)
    • riskScore: 數值風險分數(數字,必填)
    • riskLevel: 風險等級標籤,例如 Critical/High/Medium/Low(字串,必填)
    • link: 供應商 UI 中報告的選填連結(字串,選填)
    • firstSeen: 首次觀察到此實體的日期,採用 ISO 8601 格式(字串,選填)
    • lastSeen: 最近一次觀察到此實體的日期,採用 ISO 8601 格式(字串,選填)
    • triggeredRuleCount: 已觸發的 Recorded Future 規則數量(數字,選填)
    • maxRuleCount: 評估的 Recorded Future 規則數量上限(數字,選填)
    • summary: Recorded Future 提供的選填摘要文字(字串,選填)
    • criticalityLabel: Recorded Future 對此實體的關鍵性標籤(字串,選填)

傳回已建立的情資報告。

get_intelligence_reports_by_vendor - 取得供應商的所有情資報告

  • vendorDomain: 供應商的主要網域名稱(字串,必填)

傳回指定供應商的情資報告清單。

get_intelligence_report - 依 ID 取得情資報告

  • id: 報告 ID(UUID,必填)

update_bitsight_intelligence_report、update_security_scorecard_intelligence_report、update_recorded_future_intelligence_report - 取代現有情資報告

  • id: 報告 ID(UUID,必填)
  • request: 與相符的 create_*_intelligence_report 工具相同的欄位。省略的選填欄位會被清除。

delete_intelligence_report - 永久刪除情資報告

  • id: 報告 ID(UUID,必填)

bulk_create_bitsight_intelligence_reports、bulk_create_security_scorecard_intelligence_reports、bulk_create_recorded_future_intelligence_reports - 一次建立最多 1000 份情資報告

  • reports: 與相符的 create_*_intelligence_report 工具相同的欄位(物件[],必填)

傳回 totalCount、created 報告 ID,以及已排入背景建立佇列的報告之 backgroundedCount。

get_latest_intelligence_report - 從特定來源取得供應商最新的情資報告

  • vendorDomain: 供應商的主要網域名稱(字串,必填)
  • source: 情資提供者(字串列舉:BITSIGHT、SECURITY_SCORECARD 或 RECORDED_FUTURE,必填)

傳回指定供應商和來源的最新情資報告。

風險公告

get_risk_advisories_by_vendor - 取得供應商的所有風險公告

  • vendorId: 供應商 ID(數字,必填)

傳回為該供應商發布的安全、合規、弱點、法律、地緣政治、財務及營運公告。

使用者

get_all_users - 取得組織中的所有使用者

  • page:要擷取的結果頁面(數字,選填;預設值為 0)
  • size:每頁的記錄數(數字,選填;預設值為 20)
  • sort:排序條件,格式為:property(,asc|desc)(字串,選填)

傳回分頁的使用者清單。

get_user_by_email - 依電子郵件取得使用者

  • email:使用者的電子郵件地址(字串,必填)

傳回使用者詳細資料。

create_user - 建立新使用者

  • request:使用者建立參數(物件,必填)
    • email:新使用者的電子郵件地址(字串,必填)
    • firstName:新使用者的名字(字串,必填)
    • lastName:新使用者的姓氏(字串,必填)

傳回已建立的使用者。

程式碼格式

此專案使用 Spotless 搭配 Google Java Format 格式化程式碼。系統會自動設定 pre-commit hook,以確保程式碼風格一致。

設定

複製儲存庫後,執行任何 Gradle 命令時都會自動設定 pre-commit hook。

手動格式化

若要手動格式化所有檔案:

./gradlew spotlessApply

若要檢查檔案格式是否正確:

./gradlew spotlessCheck

如果 pre-commit hook 因格式問題而拒絕提交,只要執行 ./gradlew spotlessApply 修正格式,然後再次嘗試提交即可。

授權條款

此專案採用 MIT License 授權,詳情請參閱 LICENSE 檔案。