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?

  • Tìm kiếm thư mục nhà cung cấp theo tên miền — Tra cứu nhà cung cấp trong VISO TRUST bằng cách sử dụng search_vendor_directory với URL hoặc tên miền.
  • Quản lý mối quan hệ với bên thứ ba — Tạo, cập nhật, tìm kiếm, đưa vào, loại bỏ hoặc lưu trữ các mối quan hệ nhà cung cấp bằng các công cụ như create_relationship, update_relationshiponboard_relationship.
  • Chạy và theo dõi đánh giá nhà cung cấp — Bắt đầu đánh giá bằng create_assessment, truy xuất kết quả qua get_assessment, và cập nhật thời hạn hoặc cài đặt theo dõi.
  • Xem lại hoạt động nhật ký kiểm toán — Truy vấn sự kiện kiểm toán của người dùng hoặc toàn bộ bằng get_user_audit_log_eventsget_audit_log_events trong một khoảng thời gian nhất định.
  • Tiếp nhận báo cáo thông tin tình báo bên ngoài — Gửi báo cáo BitSight, SecurityScorecard hoặc Recorded Future bằng cách sử dụng create_bitsight_intelligence_report, create_security_scorecard_intelligence_report hoặc create_recorded_future_intelligence_report.
  • Cấu hình webhook — Tạo, cập nhật, xóa hoặc kiểm tra cấu hình webhook bằng create_webhook_configuration, update_webhook_configurationget_all_webhooks.

Tài liệu

VISO TRUST MCP Server

Máy chủ Giao thức Ngữ cảnh Mô hình (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 phải 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 bất kỳ máy khách MCP nào với điểm cuối này bằng cách sử dụng truyền tải HTTP có thể Truyền phát và xác thực bằng mã thông báo API VISO TRUST của bạn. Để biết thông tin về cách tạo mã thông báo API, hãy xem tài liệu hỗ trợ VISO TRUST.

Ví dụ về cấu hình máy khách:

{
    "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 Loại Truyền tải thành HTTP có thể Truyền phát và sử dụng URL ở trên.

Phần còn lại của tài liệu này đề cập đến việc 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 (tùy chọn cho triển khai trong container)
  • MCP Inspector (tùy chọn để kiểm tra)

Cấu hình

Cấu hình API VISO TRUST

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

  • visotrust.api.base-url: URL cơ sở cho 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 thông tin về 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 để kích hoạt các cấu hình khác nhau cho các tình huống triển khai khác nhau.

Hồ sơ Từ xa

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

Sự khác biệt chính trong hồ sơ từ xa:

  • Chạy như một ứng dụng web servlet (Tomcat) trên cổng 3001 thay vì I/O tiêu chuẩn
  • Hiển thị điểm cuối MCP tại POST /mcp (HTTP có thể Truyền phát)
  • Chạy ở chế độ không trạng thái — không có trạng thái máy chủ theo phiên, vì vậy nó có thể mở rộng theo chiều ngang phía sau bộ cân bằng tải mà không yêu cầu ái lực phiên
  • Cài đặt máy chủ được tối ưu hóa cho các kết nối máy khách từ xa
  • Ghi nhật ký nâng cao để gỡ lỗi phân tán

Lưu ý: Máy khách kết nối với điểm cuối HTTP có thể Truyền phát duy nhất …/mcp. Các điểm cuối SSE cũ (/sse + /mcp/message) không còn được phục vụ.

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

Khi chạy trực tiếp với Java:

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

Khi chạy với Gradle:

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

Khi sử 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 sử dụng hồ sơ từ xa:

  • 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 máy khách sẽ kết nối qua HTTP có thể Truyền phát thay vì stdio trực tiếp
  • Khi bạn cần ghi nhật ký và giám sát nâng cao cho các triển khai phân tán
  • Khi tích hợp với các trợ lý AI dựa trên web kết nối qua HTTP có thể Truyền phát

Đối với phát triển cục bộ và giao tiếp stdio trực tiếp, hãy sử 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 VISO MCP Server 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 Cài đặt Người dùng (JSON) của bạn trong VS Code. Bạn có thể thực hiện việc này bằng cách nhấn Ctrl + Shift + P và 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}"
        }
      }
    }
  }
}

Tùy chọn, bạn 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 không gian làm việc của bạn. Điều này sẽ 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 Máy 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 sử dụng để đặt các tùy chọn JVM cho gỡ lỗi từ xa. Địa chỉ và cổng có thể được thay đổi khi cần.

💻 Phát triển

Thiết lập Docker

Xây dựng Hình ả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 tra

  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 thế <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 từ 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 làm việc bao gồm các công việc sau:

Kiểm tra Định dạng

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

Xuất bản

Khi một bản phát hành mới được tạo:

  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 từ thẻ phát hành
  3. Xây dựng và đẩy hình ả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 để Xuất bản

Để kích hoạt xuất bản Docker Hub, hãy thêm các bí mật này 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 cho các công cụ được hiển thị bởi VISO MCP Server. Mỗi công cụ có một mục đích cụ thể, tham số đầu vào và định dạng đầu ra.

Đánh giá

get_assessment - Lấy đánh giá theo ID của nó

  • 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 tóm tắt cho một đánh giá theo ID của nó

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

Trả về chi tiết tóm tắt cho một đánh giá cụ thể.

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, tùy chọn)
  • recipientFirstName: Tên của người nhận đánh giá (chuỗi, tùy chọn)
  • recipientLastName: Họ của người nhận đánh giá (chuỗi, tùy chọn)
  • publicDocumentUrls: URL của các tài liệu công khai để đưa vào đánh giá (chuỗi[], tùy chọn)
  • followupType: Loại theo dõi (enum chuỗi, tùy chọn)
  • followupRiskThreshold: Ngưỡng mức độ rủi ro kích hoạt theo dõi (enum chuỗi, tùy chọn)
  • followupTimeline: Mốc thời gian cho các hành động theo dõi (enum chuỗi, tùy chọn)
  • collectionTimeline: Mốc thời gian để nhà cung cấp hoàn thành việc gửi đánh giá (enum chuỗi, tùy chọn)
  • noVendorResponseAction: Hành động cần thực hiện khi nhà cung cấp không phản hồi (enum chuỗi, tùy chọn)
  • aiProcessingOnly: Có chỉ xử lý bằng AI mà không cần xem xét của con người hay không (boolean, tùy chọn)
  • requestedAuditTypes: Các loại kiểm toán được yêu cầu cho đánh giá này (chuỗi[], tùy chọn)

Trả về chi tiết đánh giá đã tạo.

update_assessment_expiration_date - Cập nhật thời hạn mà nhà cung cấp phải gửi phản hồi đánh giá của họ

  • id: ID Đánh giá (số, bắt buộc)
  • expirationDate: Ngày/giờ hết hạn mới, ISO-8601 có độ lệch; phải ở trong 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 cho một đánh giá

  • id: ID Đánh giá (số, bắt buộc)
  • followupType: Loại theo dõi (enum chuỗi, bắt buộc)
  • followupRiskThreshold: Ngưỡng rủi ro mà tại hoặc trên đó một đánh giá theo dõi sẽ được kích hoạt (enum chuỗi, tùy chọn)
  • followupTimeline: Mốc thời gian theo dõi (enum chuỗi, tùy chọn)

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 trong phạm vi người dùng cho tổ chức của bạn

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

Trả về danh sách các 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 của truy vấn, ISO-8601 có độ lệch (chuỗi, bắt buộc)
  • end: Ngày/giờ kết thúc của truy vấn, ISO-8601 có độ lệch (chuỗi, bắt buộc)
  • eventTypes: Tập hợp tùy chọn các loại sự kiện để lọc (ví dụ: ASSESSMENT_COMPLETED, RELATIONSHIP_CREATED); để trống cho tất cả (chuỗi[], tùy chọn)

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

Trường hợp Kinh doanh

get_all_business_cases - Lấy tất cả các trường hợp kinh doanh có sẵn cho tổ chức của bạn

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

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

Loại Dữ liệu

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

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

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

Thư mục Nhà cung cấp

search_vendor_directory - Tra cứu nhà cung cấp trong thư mục 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 nhà cung cấp cơ bản (tên, trang chủ, mô tả, biểu tượng yêu thích, các tên miền đã biết).

Mối quan hệ

get_all_relationships - Lấy danh sách tất cả các mối quan hệ và chi tiết đá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à chi tiết liên hệ.

get_relationship_by_id - Lấy một mối quan hệ cụ thể và chi tiết đánh giá của nó 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à chi tiết liên hệ.

get_relationship_assessment_history - Lấy lịch sử đánh giá cho 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á được liên kết với mối quan hệ đã 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 của 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 doanh nghiệp (chuỗi, bắt buộc)
  • businessOwnerFirstName: Tên của chủ sở hữu doanh nghiệp (chuỗi, tùy chọn)
  • businessOwnerLastName: Họ của chủ sở hữu doanh nghiệp (chuỗi, tùy chọn)
  • description: Mô tả về mối quan hệ/nhà cung cấp (chuỗi, tùy chọn)
  • contextTypes: Danh sách các loại ngữ cảnh kinh doanh cho mối quan hệ này (đối tượng[], 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 (đối tượng[], tùy chọn)
  • tags: Danh sách các thẻ để phân loại mối quan hệ này (chuỗi[], tùy chọn)
  • thirdPartyContact: Chi tiết liên hệ của đại diện nhà cung cấp bên thứ ba (đối tượng, tùy chọn)

Trả về chi tiết mối quan hệ đã tạo.

create_relationship_by_domain - Tạo mối quan hệ mới chỉ sử dụng tên miền nhà cung cấp

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

Trả về chi tiết mối quan hệ đã 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ệ (số, bắt buộc)
  • name: Tên của 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, tùy chọn)
  • description: Mô tả về mối quan hệ/nhà cung cấp (chuỗi, tùy chọn)
  • contextTypes: Danh sách các loại ngữ cảnh kinh doanh (mảng đối tượng, 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 (mảng đối tượng, tùy chọn)
  • businessOwnerEmail: Địa chỉ email của chủ sở hữu nghiệp vụ (chuỗi, tùy chọn)
  • businessOwnerFirstName: Tên của chủ sở hữu nghiệp vụ (chuỗi, tùy chọn)
  • businessOwnerLastName: Họ của chủ sở hữu nghiệp vụ (chuỗi, tùy chọn)
  • tags: Danh sách thẻ (mảng chuỗi, tùy chọn)

Trả về chi tiết mối quan hệ đã được 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ề chi tiết mối quan hệ đã được cập nhật.

search_relationships - Tìm kiếm mối quan hệ theo tên miền hoặc tên nhà cung cấp

  • domains: Danh sách tên miền cần tìm kiếm (mảng chuỗi, bắt buộc)
  • name: Tên của nhà cung cấp/mối quan hệ cần tìm kiếm (chuỗi, bắt buộc)

Trả về danh sách các mối quan hệ phù hợp cùng với chi tiết đánh giá của chúng.

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 (mảng chuỗi, bắt buộc)

Trả về danh sách tất cả các thẻ bao gồm cả những thẻ mới được tạo.

update_third_party_contact - Cập nhật chi tiết liên hệ cho nhà cung cấp bên thứ ba

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

Trả về chi tiết mối quan hệ đã được cập nhật.

onboard_relationship - Tiếp nhận một 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ệ (số, bắt buộc)
  • approvalSummary: Tóm tắt phê duyệt tùy chọn được ghi lại khi tiếp nhận (chuỗi, tùy chọn)
  • lifecycleManagementUpdateRequest: Cài đặt quản lý vòng đời tùy chọn (đối tượng, tùy chọn)
    • artifactUpdateSettings.artifactUpdateType: Loại cập nhật tạo phẩm (enum chuỗi)
    • recertificationSettings.recertificationType: Loại tái chứng nhận (enum chuỗi)
    • recertificationSettings.recertificationDate: Ngày/giờ tái chứng nhận tiếp theo, ISO-8601 có độ lệch (chuỗi)
    • recertificationSettings.reviewFrequency: THREE_YEARS, TWO_YEARS, ANNUAL, SEMIANNUAL, hoặc QUARTERLY (enum chuỗi)

Trả về chi tiết mối quan hệ đã được tiếp nhận.

offboard_relationship - Ngừng tiếp nhận một mối quan hệ

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

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

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

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

Trả về chi tiết mối quan hệ đã được lưu trữ.

Webhooks

get_all_webhooks - Lấy tất cả webhook

Không yêu cầu 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 (số, bắt buộc)

Trả về 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 (đối tượng, bắt buộc)
    • url: URL Webhook (chuỗi, bắt buộc)
    • secret: Bí mật Webhook (chuỗi, bắt buộc)
    • eventTypes: Các loại sự kiện kích hoạt webhook (mảng chuỗi, bắt buộc)
    • serviceType: Loại dịch vụ cho webhook (chuỗi, bắt buộc)

Trả về cấu hình webhook đã được tạo.

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

  • request: Tham số cập nhật webhook (đối tượng, bắt buộc)
    • id: ID Webhook (số, bắt buộc)
    • url: URL Webhook (chuỗi, tùy chọn)
    • secret: Bí mật Webhook (chuỗi, tùy chọn)
    • eventTypes: Các loại sự kiện kích hoạt webhook (mảng chuỗi, tùy chọn)
    • serviceType: Loại dịch vụ cho webhook (chuỗi, tùy chọn)

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

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

  • id: ID Webhook (số, bắt buộc)

Xóa cấu hình webhook đã 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 (đối tượng, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (chuỗi, bắt buộc)
    • reportDate: Ngày/giờ báo cáo được tạ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 (chuỗi, tùy chọn)
    • guid: GUID BitSight cho thực thể (chuỗi, bắt buộc)
    • customId: Định danh tùy chỉnh từ BitSight (chuỗi, tùy chọn)
    • name: Tên hiển thị của thực thể BitSight (chuỗi, tùy chọn)
    • description: Mô tả về thực thể BitSight (chuỗi, tùy chọn)
    • primaryDomain: Tên miền chính cho thực thể BitSight (chuỗi, tùy chọn)
    • ratingRange: Phạm vi xếp hạng BitSight (chuỗi, tùy chọn)
    • ratingColor: Màu xếp hạng BitSight (chuỗi, tùy chọn)
    • confidence: Mức độ tin cậy của xếp hạng BitSight (chuỗi, tùy chọn)

Trả về báo cáo tình báo đã được 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 (đối tượng, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (chuỗi, bắt buộc)
    • reportDate: Ngày/giờ báo cáo được tạ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 (chuỗi, tùy chọn)
    • grade: Điểm chữ SecurityScorecard (chuỗi, bắt buộc)
    • domain: Tên miền liên kết với thực thể scorecard (chuỗi, tùy chọn)
    • score: Điểm số từ SecurityScorecard (số, tùy chọn)

Trả về báo cáo tình báo đã được 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 (đối tượng, bắt buộc)
    • vendorDomain: Tên miền chính của nhà cung cấp (chuỗi, bắt buộc)
    • reportDate: Ngày/giờ báo cáo được tạo (chuỗi ISO 8601, bắt buộc)
    • entityType: Loại thực thể Recorded Future, ví dụ: Company (chuỗi, bắt buộc)
    • entity: Định danh thực thể Recorded Future (chuỗi, bắt buộc)
    • riskScore: Điểm rủi ro số (số, bắt buộc)
    • riskLevel: Nhãn mức độ rủi ro, ví dụ: Critical/High/Medium/Low (chuỗi, 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 (chuỗi, tùy chọn)
    • firstSeen: Ngày quan sát sớm nhất cho thực thể, ISO 8601 (chuỗi, tùy chọn)
    • lastSeen: Ngày quan sát gần đây nhất cho thực thể, ISO 8601 (chuỗi, tùy chọn)
    • triggeredRuleCount: Số lượng quy tắc Recorded Future đã được kích hoạt (số, tùy chọn)
    • maxRuleCount: Số lượng quy tắc Recorded Future tối đa được đánh giá (số, tùy chọn)
    • summary: Văn bản tóm tắt tùy chọn từ Recorded Future (chuỗi, tùy chọn)
    • criticalityLabel: Nhãn mức độ nghiêm trọng Recorded Future cho thực thể (chuỗi, tùy chọn)

Trả về báo cáo tình báo đã được tạo.

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

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

Trả về danh sách các báo cáo tình báo cho nhà cung cấp đã chỉ định.

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

  • vendorDomain: Tên miền chính của nhà cung cấp (chuỗi, bắt buộc)
  • source: Nhà cung cấp tình báo (enum chuỗi: 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 cho nhà cung cấp và nguồn đã chỉ định.

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ố, tùy chọn; mặc định 0)
  • size: Số bản ghi mỗi trang (số, tùy chọn; mặc định 20)
  • sort: Tiêu chí sắp xếp theo định dạng: property(,asc|desc) (chuỗi, tùy chọn)

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ề chi tiết 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 đã được tạo.

Định dạng Mã nguồn

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

Thiết lập

Sau khi sao chép kho lưu trữ, hook pre-commit sẽ được tự động thiết lập 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 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 và sau đó thử commit lại.

Giấy phép

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