VISO TRUST

chính thức

Truy cập và quản lý chương trình rủi ro bên thứ ba VISO TRUST của bạn trực tiếp thông qua trợ lý AI.

Bạn có thể làm gì với VISO TRUST MCP?

  • Tra cứu đánh giá nhà cung cấp — Truy xuất một đánh giá cụ thể theo ID, bao gồm bản tóm tắt do AI tạo ở định dạng HTML hoặc Markdown.
  • Tạo và quản lý đánh giá — Bắt đầu đánh giá cho một mối quan hệ hiện có, cập nhật ngày hết hạn hoặc điều chỉnh cài đặt theo dõi.
  • Tìm kiếm mối quan hệ với nhà cung cấp — Lọc các mối quan hệ theo thẻ, miền, trạng thái, mức độ rủi ro, khoảng điểm, đơn vị kinh doanh và ngày tháng.
  • Tiếp nhận hoặc ngừng hợp tác với nhà cung cấp — Tiếp nhận một mối quan hệ kèm bản tóm tắt phê duyệt và cài đặt vòng đời, hoặc ngừng hợp tác và lưu trữ mối quan hệ đó.
  • Xem lại nhật ký kiểm tra — Truy vấn các sự kiện kiểm tra về người dùng, tổ chức, đánh giá và mối quan hệ trong một khoảng thời gian.
  • Quản lý báo cáo tình báo — Tạo, cập nhật hoặc truy xuất báo cáo BitSight, SecurityScorecard và Recorded Future cho miền của nhà cung cấp.

Tài liệu

Máy chủ MCP VISO TRUST

Máy chủ Model Context Protocol (MCP) để tích hợp các khả năng của API VISO TRUST với trợ lý AI.

Máy chủ từ xa được lưu trữ

VISO TRUST lưu trữ một phiên bản được quản lý của máy chủ MCP này, vì vậy bạn không cần xây dựng, chạy hoặc tự lưu trữ bất cứ thứ gì để bắt đầu:

https://mcp.visotrust.com/mcp

Kết nối mọi ứng dụng khách MCP với điểm cuối này bằng phương thức truyền tải Streamable HTTP và xác thực bằng mã thông báo API VISO TRUST của bạn. Để biết cách tạo mã thông báo API, hãy xem tài liệu hỗ trợ VISO TRUST.

Cấu hình ứng dụng khách mẫu:

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

Để kiểm tra điểm cuối được lưu trữ bằng MCP Inspector, hãy chạy npx @modelcontextprotocol/inspector, đặt Transport Type thành Streamable HTTP và sử dụng URL ở trên.

Phần còn lại của tài liệu này hướng dẫn cách tự chạy máy chủ (cục bộ hoặc trong cơ sở hạ tầng của riêng bạn).

Yêu cầu

  • Java 21+
  • Gradle
  • Docker (không bắt buộc nếu triển khai bằng container)
  • MCP Inspector (không bắt buộc để kiểm thử)

Cấu hình

Cấu hình API VISO TRUST

Có thể cấu hình các thuộc tính sau cho API VISO TRUST:

  • visotrust.api.base-url: URL cơ sở của API VISO TRUST (mặc định: http://localhost:8080)
  • visotrust.api.token: Mã thông báo API của bạn từ nền tảng VISO TRUST (bắt buộc)
  • visotrust.api.timeout: Thời gian chờ yêu cầu API tính bằng mili giây (mặc định: 30000)
  • visotrust.api.connect-timeout: Thời gian chờ kết nối API tính bằng mili giây (mặc định: 5000)

Để biết cách tạo mã thông báo API cho biến môi trường visotrust.api.token, hãy xem tài liệu hỗ trợ VISO TRUST.

Hồ sơ ứng dụng

Ứng dụng này hỗ trợ các hồ sơ Spring Boot để bật những cấu hình khác nhau cho từng tình huống triển khai.

Hồ sơ Remote

Hồ sơ remote được thiết kế để hỗ trợ MCP từ xa qua phương thức truyền tải Streamable HTTP. Hồ sơ này chạy máy chủ dưới dạng ứng dụng web để có thể giao tiếp với các ứng dụng khách từ xa qua HTTP. (Streamable HTTP thay thế phương thức truyền tải SSE đã lỗi thời; tại đây, phương thức này được cấu hình ở chế độ không trạng thái.)

Các điểm khác biệt chính của hồ sơ remote:

  • Chạy dưới dạng ứng dụng web servlet (Tomcat) trên cổng 3001 thay vì dùng standard I/O
  • Cung cấp điểm cuối MCP tại POST /mcp (Streamable HTTP)
  • Chạy ở chế độ không trạng thái — không lưu trạng thái máy chủ theo từng phiên, nhờ đó có thể mở rộng theo chiều ngang phía sau bộ cân bằng tải mà không cần duy trì tính liên kết phiên
  • Tối ưu hóa cài đặt máy chủ cho các kết nối từ ứng dụng khách từ xa
  • Tăng cường ghi nhật ký để hỗ trợ gỡ lỗi trong môi trường phân tán

Lưu ý: Ứng dụng khách kết nối với điểm cuối Streamable HTTP duy nhất …/mcp. Các điểm cuối SSE cũ (/sse + /mcp/message) không còn được cung cấp.

Cách kích hoạt hồ sơ remote:

Khi chạy trực tiếp bằng Java:

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

Khi chạy bằng Gradle:

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

Khi dùng Docker:

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

Khi nào nên dùng hồ sơ remote:

  • Khi triển khai máy chủ MCP lên máy chủ từ xa hoặc môi trường đám mây
  • Khi ứng dụng khách kết nối qua Streamable HTTP thay vì stdio trực tiếp
  • Khi cần tăng cường ghi nhật ký và giám sát cho các triển khai phân tán
  • Khi tích hợp với trợ lý AI trên web kết nối qua Streamable HTTP

Để phát triển cục bộ và giao tiếp stdio trực tiếp, hãy dùng hồ sơ mặc định (không cần chỉ định hồ sơ).

Cài đặt

Cài đặt nhanh

Nhấp vào một trong các nút bên dưới để cài đặt Máy chủ MCP VISO trong VS Code:

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

Thiết lập thủ công với VS Code

Thêm khối JSON sau vào tệp User Settings (JSON) trong VS Code. Bạn có thể thực hiện việc này bằng cách nhấn Ctrl + Shift + P rồi nhậ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}"
        }
      }
    }
  }
}

Bạn cũng có thể thêm một ví dụ tương tự (tức là không có khóa mcp) vào tệp có tên .vscode/mcp.json trong workspace. Cách này cho phép bạn chia sẻ cấu hình với người khác.

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

Sử dụng với Claude Desktop và các ứng dụng khách MCP khác

Cấu hình 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"
            }
        }
    }
}

Cấu hình 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"
            }
        }
    }
}

Lưu ý: Biến môi trường JAVA_TOOL_OPTIONS được dùng để thiết lập các tùy chọn JVM cho gỡ lỗi từ xa. Có thể thay đổi địa chỉ và cổng khi cần.

💻 Phát triển

Thiết lập Docker

Xây dựng ảnh Docker

docker build -t viso-mcp-server .

Chạy container Docker

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

Gỡ lỗi

Cài đặt MCP Inspector

npm -g install @modelcontextprotocol/inspector

Chạy MCP Inspector để kiểm thử

  1. Xây dựng tệp JAR của máy chủ MCP
./gradlew bootJar
  1. Chạy 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

Thay <version> bằng phiên bản hiện tại của dự án (ví dụ: 1.0.0 hoặc phiên bản trong bản phát hành mới nhất).

Quy trình CI/CD

Dự án này sử dụng GitHub Actions để tích hợp và triển khai liên tục. Quy trình bao gồm các tác vụ sau:

Kiểm tra kiểu mã

Kiểm tra định dạng mã bằng Spotless:

./gradlew spotlessCheck

Xây dựng

Xây dựng ứng dụng và tạo tệp JAR:

./gradlew build

Phát hành

Khi tạo bản phát hành mới:

  1. Cập nhật phiên bản dự án trong build.gradle để khớp với thẻ phát hành
  2. Tải tệp JAR lên bản phát hành GitHub với phiên bản lấy từ thẻ phát hành
  3. Xây dựng và đẩy ảnh Docker lên Docker Hub với các thẻ:
    • latest
    • Thẻ phát hành (ví dụ: v1.0.0)
Bí mật bắt buộc để phát hành

Để bật tính năng phát hành lên Docker Hub, hãy thêm các bí mật sau vào kho lưu trữ GitHub của bạn:

  • DOCKERHUB_USERNAME: Tên người dùng Docker Hub của bạn
  • DOCKERHUB_TOKEN: Mã thông báo truy cập Docker Hub của bạn

🛠️ Công cụ

Phần này cung cấp tài liệu về các công cụ do Máy chủ MCP VISO cung cấp. Mỗi công cụ có mục đích, tham số đầu vào và định dạng đầu ra riêng.

Đánh giá

get_assessment - Lấy một đánh giá theo ID

  • id: ID đánh giá (số, bắt buộc)

Trả về thông tin chi tiết về một đánh giá cụ thể.

get_assessment_summary - Lấy bản tóm tắt của một đánh giá theo ID

  • id: ID đánh giá (số, bắt buộc)
  • format: HTML (mặc định) hoặc MARKDOWN (chuỗi, không bắt buộc)

Trả về bản tóm tắt, version của bản tóm tắt và cho biết bản tóm tắt đã được edited hay chưa.

update_assessment_summary - Thay thế nội dung bản tóm tắt do AI tạo của một đánh giá đã hoàn tất

  • id: ID đánh giá (số, bắt buộc)
  • summary: Bản tóm tắt đã chỉnh sửa (chuỗi, bắt buộc)
  • format: HTML (mặc định) hoặc MARKDOWN (chuỗi, không bắt buộc)
  • version: version từ get_assessment_summary; yêu cầu cập nhật sẽ bị từ chối nếu bản tóm tắt đã thay đổi kể từ thời điểm đó (chuỗi, không bắt buộc)

Trả về bản tóm tắt đã cập nhật theo định dạng được gửi.

create_assessment - Bắt đầu đánh giá cho một mối quan hệ hiện có

  • relationshipId: ID của mối quan hệ cần tạo đánh giá (số, bắt buộc)
  • recipientEmail: Địa chỉ email của người nhận đánh giá (chuỗi, không bắt buộc)
  • recipientFirstName: Tên của người nhận đánh giá (chuỗi, không bắt buộc)
  • recipientLastName: Họ của người nhận đánh giá (chuỗi, không bắt buộc)
  • publicDocumentUrls: URL của các tài liệu công khai cần đưa vào đánh giá (string[], không bắt buộc)
  • followupType: Loại theo dõi tiếp theo (enum chuỗi, không bắt buộc)
  • followupRiskThreshold: Ngưỡng mức độ rủi ro kích hoạt việc theo dõi tiếp theo (enum chuỗi, không bắt buộc)
  • followupTimeline: Lịch trình cho các hành động theo dõi tiếp theo (enum chuỗi, không bắt buộc)
  • collectionTimeline: Thời hạn để nhà cung cấp hoàn tất việc gửi đánh giá (enum chuỗi, không bắt buộc)
  • noVendorResponseAction: Hành động cần thực hiện khi nhà cung cấp không phản hồi (enum chuỗi, không bắt buộc)
  • aiProcessingOnly: Chỉ xử lý bằng AI mà không cần con người xem xét hay không (boolean, không bắt buộc)
  • requestedAuditTypes: Các loại kiểm toán được yêu cầu cho đánh giá này (string[], không bắt buộc)

Trả về thông tin chi tiết về đánh giá vừa tạo.

update_assessment_expiration_date - Cập nhật hạn chót nhà cung cấp phải gửi phản hồi đánh giá

  • id: ID đánh giá (số, bắt buộc)
  • expirationDate: Ngày/giờ hết hạn mới, theo ISO-8601 có độ lệch múi giờ; phải ở tương lai (chuỗi, bắt buộc)

Trả về thông báo xác nhận.

update_assessment_followup - Cập nhật cấu hình theo dõi tiếp theo cho một đánh giá

  • id: ID đánh giá (số, bắt buộc)
  • followupType: Loại theo dõi tiếp theo (enum chuỗi, bắt buộc)
  • followupRiskThreshold: Ngưỡng rủi ro mà tại đó hoặc cao hơn sẽ kích hoạt đánh giá theo dõi tiếp theo (enum chuỗi, không bắt buộc)
  • followupTimeline: Lịch trình theo dõi tiếp theo (enum chuỗi, không bắt buộc)

Trả về thông báo xác nhận.

Nhật ký kiểm toán

get_user_audit_log_events - Lấy các sự kiện nhật ký kiểm toán theo người dùng trong tổ chức của bạn

  • start: Ngày/giờ bắt đầu truy vấn, theo ISO-8601 có độ lệch múi giờ (chuỗi, bắt buộc)
  • end: Ngày/giờ kết thúc truy vấn, theo ISO-8601 có độ lệch múi giờ (chuỗi, bắt buộc)
  • eventTypes: Tập hợp tùy chọn các loại sự kiện cần lọc (ví dụ: USER_LOGGED_IN); để trống để lấy tất cả (string[], không bắt buộc)

Trả về danh sách sự kiện nhật ký kiểm toán của người dùng, giới hạn ở 500 bản ghi.

get_audit_log_events - Lấy các sự kiện nhật ký kiểm toán đã lọc (sự kiện người dùng, tổ chức, đánh giá và mối quan hệ)

  • start: Ngày/giờ bắt đầu truy vấn, theo ISO-8601 có độ lệch múi giờ (chuỗi, bắt buộc)
  • end: Ngày/giờ kết thúc truy vấn, theo ISO-8601 có độ lệch múi giờ (chuỗi, bắt buộc)
  • eventTypes: Tập hợp tùy chọn các loại sự kiện cần lọc (ví dụ: ASSESSMENT_COMPLETED, RELATIONSHIP_CREATED); để trống để lấy tất cả (string[], không bắt buộc)

Trả về các bản ghi sự kiện nhật ký kiểm toán đa hình. Mỗi mục có ít nhất auditEventType và dateTime.

Đơn vị kinh doanh

get_all_business_units - Lấy tất cả đơn vị kinh doanh trong tổ chức của bạn, sắp xếp theo tên

Trả về id của từng đơn vị kinh doanh (có thể dùng làm bộ lọc businessUnitIds trong search_relationships) và name (có thể dùng làm businessUnit trong create_user).

Trường hợp kinh doanh

get_all_business_cases - Lấy tất cả trường hợp kinh doanh hiện có trong tổ chức của bạn

Không yêu cầu tham số.

Trả về danh sách tất cả trường hợp kinh doanh hiện có trong tổ chức của bạn.

Loại dữ liệu

get_all_datatypes - Lấy tất cả loại dữ liệu hiện có trong tổ chức của bạn

Không yêu cầu tham số.

Trả về danh sách tất cả loại dữ liệu hiện có trong tổ chức của bạn.

Danh bạ nhà cung cấp

search_vendor_directory - Tra cứu nhà cung cấp trong danh bạ nhà cung cấp VISO TRUST theo URL hoặc tên miền

  • urlOrDomain: URL hoặc tên miền cần tìm kiếm, ví dụ: example.com (chuỗi, bắt buộc)

Trả về siêu dữ liệu cơ bản của nhà cung cấp (tên, trang chủ, mô tả, favicon, các tên miền đã biết).

Mối quan hệ

get_all_relationships - Lấy danh sách tất cả mối quan hệ và thông tin chi tiết về các đánh giá của chúng

Không yêu cầu tham số.

Trả về thông tin về các nhà cung cấp bên thứ ba, bao gồm trạng thái đánh giá, mức độ rủi ro và thông tin liên hệ.

get_relationship_by_id - Lấy một mối quan hệ cụ thể và thông tin chi tiết về các đánh giá theo ID

  • id: ID mối quan hệ (số, bắt buộc)

Trả về thông tin chi tiết về một nhà cung cấp bên thứ ba, bao gồm trạng thái đánh giá, mức độ rủi ro và thông tin liên hệ.

get_relationship_assessment_history - Lấy lịch sử đánh giá của một mối quan hệ

  • id: ID mối quan hệ (số, bắt buộc)

Trả về danh sách các đánh giá liên kết với mối quan hệ được chỉ định.

create_relationship - Tạo mối quan hệ mới với nhà cung cấp bên thứ ba

  • name: Tên mối quan hệ/nhà cung cấp (chuỗi, bắt buộc)
  • homepage: URL trang chủ của nhà cung cấp (chuỗi, bắt buộc)
  • businessOwnerEmail: Địa chỉ email của chủ sở hữu nghiệp vụ (chuỗi, bắt buộc)
  • businessOwnerFirstName: Tên của chủ sở hữu nghiệp vụ (chuỗi, không bắt buộc)
  • businessOwnerLastName: Họ của chủ sở hữu nghiệp vụ (chuỗi, không bắt buộc)
  • description: Mô tả mối quan hệ/nhà cung cấp (chuỗi, không bắt buộc)
  • contextTypes: Danh sách các loại ngữ cảnh kinh doanh cho mối quan hệ này (object[], không bắt buộc)
  • dataTypes: Danh sách các loại dữ liệu được xử lý trong mối quan hệ này (object[], không bắt buộc)
  • tags: Danh sách thẻ để phân loại mối quan hệ này (string[], không bắt buộc)
  • thirdPartyContact: Thông tin liên hệ của đại diện nhà cung cấp bên thứ ba (object, không bắt buộc)

Trả về thông tin chi tiết về mối quan hệ vừa tạo.

create_relationship_by_domain - Tạo mối quan hệ mới chỉ bằng miền của nhà cung cấp

  • domain: Miền của nhà cung cấp, ví dụ: visotrust.com (string, bắt buộc)
  • vendorName: Tên nhà cung cấp (string, bắt buộc)
  • product: Sản phẩm do nhà cung cấp cung cấp (string, tùy chọn)
  • description: Mô tả mối quan hệ với nhà cung cấp (string, tùy chọn)

Trả về thông tin chi tiết về mối quan hệ vừa tạo.

update_relationship - Cập nhật mối quan hệ hiện có với nhà cung cấp bên thứ ba

  • id: ID mối quan hệ (number, bắt buộc)
  • name: Tên mối quan hệ/nhà cung cấp (string, bắt buộc)
  • homepage: URL trang chủ của nhà cung cấp (string, tùy chọn)
  • description: Mô tả mối quan hệ/nhà cung cấp (string, tùy chọn)
  • contextTypes: Danh sách các loại ngữ cảnh kinh doanh (object[], tùy chọn)
  • dataTypes: Danh sách các loại dữ liệu được xử lý trong mối quan hệ này (object[], tùy chọn)
  • businessOwnerEmail: Địa chỉ email của chủ sở hữu nghiệp vụ (string, tùy chọn)
  • businessOwnerFirstName: Tên của chủ sở hữu nghiệp vụ (string, tùy chọn)
  • businessOwnerLastName: Họ của chủ sở hữu nghiệp vụ (string, tùy chọn)
  • tags: Danh sách thẻ (string[], tùy chọn)

Trả về thông tin chi tiết về mối quan hệ đã cập nhật.

partially_update_relationship - Cập nhật một phần mối quan hệ hiện có

Chấp nhận các trường giống như update_relationship. Chỉ các trường được cung cấp trong yêu cầu mới được thay đổi; các trường khác được giữ nguyên.

Trả về thông tin chi tiết về mối quan hệ đã cập nhật.

search_relationships - Tìm kiếm mối quan hệ theo tiêu chí lọc

Gọi POST /api/v1/relationships/search. Tất cả bộ lọc đều không bắt buộc; các bộ lọc được kết hợp bằng AND, còn các giá trị trong cùng một bộ lọc danh sách được kết hợp bằng OR.

  • request: Bộ lọc tìm kiếm (object, tùy chọn)
    • tags: Tên thẻ, chính xác như trong VISO TRUST (string[], tùy chọn)
    • domains: Tên miền của nhà cung cấp, ví dụ: example.com (string[], tùy chọn)
    • name: Tên mối quan hệ chính xác (string, tùy chọn)
    • externalId: ID bên ngoài chính xác (string, tùy chọn)
    • statuses: Trạng thái mối quan hệ — NOT_ONBOARDED, ONBOARDED, ARCHIVED (string[], tùy chọn)
    • assessmentStatuses: Trạng thái đánh giá mới nhất (string[], tùy chọn)
    • riskAcceptanceStatuses: RISK_ACCEPTED, REVIEW_NEEDED, REMEDIATION_REQUESTED (string[], tùy chọn)
    • inherentRiskLevels / residualRiskLevels: NO_CONTEXT, LOW, MEDIUM, HIGH, EXTREME (string[], tùy chọn)
    • minScore / maxScore: Khoảng điểm, bao gồm cả hai đầu mút (number, tùy chọn)
    • businessUnitIds: ID đơn vị kinh doanh từ get_all_business_units (number[], tùy chọn)
    • businessOwnerIds / creatorIds: ID người dùng từ get_all_users (number[], tùy chọn)
    • createdAfter / createdBefore, onboardedAfter / onboardedBefore, recertificationAfter / recertificationBefore, assessmentCompletedAfter / assessmentCompletedBefore: Thời điểm theo định dạng ISO-8601 (string, tùy chọn)
  • page: Số trang bắt đầu từ 0 (number, tùy chọn, mặc định 0)
  • size: Kích thước trang (number, tùy chọn, mặc định 100, tối đa 500)
  • sort: Thứ tự sắp xếp theo property,asc|desc; các thuộc tính name, externalId, score, createdDate, onboardedDate, recertificationDate (string[], tùy chọn)

Trả về totalCount, page, size, hasMore và trang chứa các relationships phù hợp.

create_tags - Tạo thẻ mới để phân loại mối quan hệ

  • tags: Danh sách tên thẻ cần tạo (string[], bắt buộc)

Trả về danh sách tất cả thẻ, bao gồm cả các thẻ vừa tạo.

update_third_party_contact - Cập nhật thông tin liên hệ của nhà cung cấp bên thứ ba

  • relationshipId: ID mối quan hệ (number, bắt buộc)
  • email: Email liên hệ (string, bắt buộc)
  • firstName: Tên người liên hệ (string, bắt buộc)
  • lastName: Họ người liên hệ (string, bắt buộc)

Trả về thông tin chi tiết về mối quan hệ đã cập nhật.

onboard_relationship - Tiếp nhận mối quan hệ, tùy chọn kèm theo tóm tắt phê duyệt và cài đặt quản lý vòng đời

  • id: ID mối quan hệ (number, bắt buộc)
  • approvalSummary: Tóm tắt phê duyệt tùy chọn được ghi nhận khi tiếp nhận (string, tùy chọn)
  • lifecycleManagementUpdateRequest: Cài đặt quản lý vòng đời tùy chọn (object, tùy chọn)
    • artifactUpdateSettings.artifactUpdateType: Loại cập nhật hiện vật (string enum)
    • recertificationSettings.recertificationType: Loại tái chứng nhận (string enum)
    • recertificationSettings.recertificationDate: Ngày/giờ tái chứng nhận tiếp theo, theo ISO-8601 có độ lệch múi giờ (string)
    • recertificationSettings.reviewFrequency: THREE_YEARS, TWO_YEARS, ANNUAL, SEMIANNUAL hoặc QUARTERLY (string enum)

Trả về thông tin chi tiết về mối quan hệ đã tiếp nhận.

offboard_relationship - Ngừng hợp tác trong một mối quan hệ

  • id: ID mối quan hệ (number, bắt buộc)

Trả về thông tin chi tiết về mối quan hệ đã ngừng hợp tác.

accept_relationship_risk - Chấp nhận rủi ro của một mối quan hệ

  • id: ID mối quan hệ (number, bắt buộc)
  • request: (object, tùy chọn)
    • riskReviewNote: Ghi chú giải thích quyết định (string, tùy chọn)
    • inherentRiskOverride / residualRiskOverride: LOW, MEDIUM, HIGH hoặc EXTREME; phải cung cấp cả hai hoặc không cung cấp trường nào (string, tùy chọn)

Trả về mối quan hệ đã cập nhật.

get_relationship_detections - Lấy các phát hiện trong bằng chứng của một mối quan hệ

  • id: ID mối quan hệ (number, bắt buộc)
  • detectionTypes: NORMAL, SUBSERVICE, SHARED_RESPONSIBILITY_MODEL, EXCEPTION, CUEC, SUBPROCESSOR; mặc định là tất cả trừ NORMAL (string[], tùy chọn)
  • controlDomainTypes: Các loại miền kiểm soát cần đưa vào; mặc định là tất cả (string[], tùy chọn)
  • assessmentId: Một đánh giá đã hoàn tất của mối quan hệ này hoặc đánh giá mới nhất đang thực hiện (number, tùy chọn)
  • includeQuestionnaireAnswers: Bao gồm các câu trả lời làm căn cứ cho những phát hiện từ bảng câu hỏi bổ sung (boolean, tùy chọn)
  • afterId: nextAfterId của trang trước (number, tùy chọn)
  • size: Số phát hiện mỗi trang, từ 1 đến 500 (number, tùy chọn, mặc định 100)

Trả về một trang phát hiện; tiếp tục đọc khi nextAfterId không phải là null.

get_risk_advisories_by_relationship - Lấy thông tin tư vấn rủi ro cho nhà cung cấp của một mối quan hệ

  • id: ID mối quan hệ (number, bắt buộc)

archive_relationship - Lưu trữ một mối quan hệ

  • id: ID mối quan hệ (number, bắt buộc)

Trả về thông tin chi tiết về mối quan hệ đã lưu trữ.

Webhook

get_all_webhooks - Lấy tất cả webhook

Không cần tham số.

Trả về danh sách tất cả cấu hình webhook.

get_webhook - Lấy cấu hình webhook theo id

  • id: ID webhook (number, bắt buộc)

Trả về thông tin chi tiết của một cấu hình webhook cụ thể.

create_webhook_configuration - Tạo cấu hình webhook

  • request: Tham số tạo webhook (object, bắt buộc)
    • url: URL webhook (string, bắt buộc)
    • secret: Bí mật webhook (string, bắt buộc)
    • eventTypes: Các loại sự kiện kích hoạt webhook (string[], bắt buộc)
    • serviceType: Loại dịch vụ cho webhook (string, bắt buộc)

Trả về cấu hình webhook vừa tạo.

update_webhook_configuration - Cập nhật cấu hình webhook

  • request: Tham số cập nhật webhook (object, bắt buộc)
    • id: ID webhook (number, bắt buộc)
    • url: URL webhook (string, tùy chọn)
    • secret: Bí mật webhook (string, tùy chọn)
    • eventTypes: Các loại sự kiện kích hoạt webhook (string[], tùy chọn)
    • serviceType: Loại dịch vụ cho webhook (string, tùy chọn)

Trả về cấu hình webhook đã cập nhật.

delete_webhook_configuration - Xóa cấu hình webhook

  • id: ID webhook (number, bắt buộc)

Xóa cấu hình webhook được chỉ định.

Báo cáo tình báo

create_bitsight_intelligence_report - Tạo báo cáo tình báo BitSight mới

  • request: Tham số báo cáo BitSight (object, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (string, bắt buộc)
    • reportDate: Ngày/giờ tạo báo cáo (chuỗi ISO 8601, bắt buộc)
    • link: Liên kết tùy chọn đến giao diện người dùng của nhà cung cấp (string, tùy chọn)
    • guid: GUID BitSight của thực thể (string, bắt buộc)
    • customId: Mã định danh tùy chỉnh từ BitSight (string, tùy chọn)
    • name: Tên hiển thị của thực thể BitSight (string, tùy chọn)
    • description: Mô tả thực thể BitSight (string, tùy chọn)
    • primaryDomain: Miền chính của thực thể BitSight (string, tùy chọn)
    • ratingRange: Khoảng xếp hạng BitSight (string, tùy chọn)
    • ratingColor: Màu xếp hạng BitSight (string, tùy chọn)
    • confidence: Mức độ tin cậy của xếp hạng BitSight (string, tùy chọn)

Trả về báo cáo tình báo vừa tạo.

create_security_scorecard_intelligence_report - Tạo báo cáo tình báo SecurityScorecard mới

  • request: Tham số báo cáo SecurityScorecard (object, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (string, bắt buộc)
    • reportDate: Ngày/giờ tạo báo cáo (chuỗi ISO 8601, bắt buộc)
    • link: Liên kết tùy chọn đến giao diện người dùng của nhà cung cấp (string, tùy chọn)
    • grade: Xếp hạng chữ của SecurityScorecard (string, bắt buộc)
    • domain: Miền liên kết với thực thể scorecard (string, tùy chọn)
    • score: Điểm số dạng số từ SecurityScorecard (number, tùy chọn)

Trả về báo cáo tình báo vừa tạo.

create_recorded_future_intelligence_report - Tạo báo cáo tình báo Recorded Future mới

  • request: Tham số báo cáo Recorded Future (object, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (string, bắt buộc)
    • reportDate: Ngày/giờ tạo báo cáo (chuỗi ISO 8601, bắt buộc)
    • entityType: Loại thực thể Recorded Future, ví dụ: Company (string, bắt buộc)
    • entity: Mã định danh thực thể Recorded Future (string, bắt buộc)
    • riskScore: Điểm rủi ro dạng số (number, bắt buộc)
    • riskLevel: Nhãn mức độ rủi ro, ví dụ: Critical/High/Medium/Low (string, bắt buộc)
    • link: Liên kết tùy chọn đến báo cáo trong giao diện người dùng của nhà cung cấp (string, tùy chọn)
    • firstSeen: Ngày sớm nhất thực thể được quan sát, theo ISO 8601 (string, tùy chọn)
    • lastSeen: Ngày gần nhất thực thể được quan sát, theo ISO 8601 (string, tùy chọn)
    • triggeredRuleCount: Số quy tắc Recorded Future đã được kích hoạt (number, tùy chọn)
    • maxRuleCount: Số quy tắc Recorded Future tối đa được đánh giá (number, tùy chọn)
    • summary: Văn bản tóm tắt tùy chọn từ Recorded Future (string, tùy chọn)
    • criticalityLabel: Nhãn mức độ quan trọng của thực thể trong Recorded Future (string, tùy chọn)

Trả về báo cáo tình báo vừa tạo.

get_intelligence_reports_by_vendor - Lấy tất cả báo cáo tình báo của một nhà cung cấp

  • vendorDomain: Tên miền chính của nhà cung cấp (string, bắt buộc)

Trả về danh sách báo cáo tình báo của nhà cung cấp được chỉ định.

get_intelligence_report - Lấy báo cáo tình báo theo ID

  • id: ID báo cáo (UUID, bắt buộc)

update_bitsight_intelligence_report, update_security_scorecard_intelligence_report, update_recorded_future_intelligence_report - Thay thế báo cáo tình báo hiện có

  • id: ID báo cáo (UUID, bắt buộc)
  • request: Các trường giống như công cụ create_*_intelligence_report tương ứng. Các trường tùy chọn bị bỏ qua sẽ được xóa.

delete_intelligence_report - Xóa vĩnh viễn báo cáo tình báo

  • id: ID báo cáo (UUID, bắt buộc)

bulk_create_bitsight_intelligence_reports, bulk_create_security_scorecard_intelligence_reports, bulk_create_recorded_future_intelligence_reports - Tạo tối đa 1000 báo cáo tình báo cùng lúc

  • reports: Các trường giống như công cụ create_*_intelligence_report tương ứng (object[], bắt buộc)

Trả về totalCount, các ID báo cáo created và backgroundedCount cho những báo cáo được đưa vào hàng đợi để tạo trong nền.

get_latest_intelligence_report - Lấy báo cáo tình báo mới nhất của nhà cung cấp từ một nguồn cụ thể

  • vendorDomain: Tên miền chính của nhà cung cấp (string, bắt buộc)
  • source: Nhà cung cấp thông tin tình báo (string enum: BITSIGHT, SECURITY_SCORECARD hoặc RECORDED_FUTURE, bắt buộc)

Trả về báo cáo tình báo mới nhất của nhà cung cấp và nguồn được chỉ định.

Thông tin tư vấn rủi ro

get_risk_advisories_by_vendor - Lấy tất cả thông tin tư vấn rủi ro của một nhà cung cấp

  • vendorId: ID nhà cung cấp (number, bắt buộc)

Trả về các thông tin tư vấn về an ninh, tuân thủ, lỗ hổng, pháp lý, địa chính trị, tài chính và vận hành được công bố cho nhà cung cấp.

Người dùng

get_all_users - Lấy tất cả người dùng trong tổ chức của bạn

  • page: Trang kết quả cần truy xuất (số, không bắt buộc; mặc định là 0)
  • size: Số bản ghi trên mỗi trang (số, không bắt buộc; mặc định là 20)
  • sort: Tiêu chí sắp xếp theo định dạng: property(,asc|desc) (chuỗi, không bắt buộc)

Trả về danh sách người dùng được phân trang.

get_user_by_email - Lấy người dùng theo email

  • email: Địa chỉ email của người dùng (chuỗi, bắt buộc)

Trả về thông tin chi tiết của người dùng.

create_user - Tạo người dùng mới

  • request: Tham số tạo người dùng (đối tượng, bắt buộc)
    • email: Địa chỉ email của người dùng mới (chuỗi, bắt buộc)
    • firstName: Tên của người dùng mới (chuỗi, bắt buộc)
    • lastName: Họ của người dùng mới (chuỗi, bắt buộc)

Trả về người dùng vừa được tạo.

Định dạng mã

Dự án này sử dụng Spotless cùng Google Java Format để định dạng mã. Một hook pre-commit được thiết lập tự động để đảm bảo phong cách mã nhất quán.

Thiết lập

Sau khi sao chép kho lưu trữ, hook pre-commit sẽ được thiết lập tự động khi bạn chạy bất kỳ lệnh Gradle nào.

Định dạng thủ công

Để định dạng thủ công tất cả các tệp:

./gradlew spotlessApply

Để kiểm tra xem các tệp đã được định dạng đúng hay chưa:

./gradlew spotlessCheck

Nếu hook pre-commit từ chối commit của bạn do vấn đề định dạng, chỉ cần chạy ./gradlew spotlessApply để sửa định dạng rồi thử commit lại.

Giấy phép

Dự án này được cấp phép theo MIT License - xem tệp LICENSE để biết chi tiết.