VISO TRUST
公式AIアシスタントを通じて、VISO TRUSTのサードパーティリスクプログラムに直接アクセスし、管理できます。
VISO TRUST MCPで何ができますか?
- ベンダー評価を検索 — IDを指定して評価を取得します。AIが生成した要約をHTMLまたはMarkdown形式で含めることができます。
- 評価を作成・管理 — 既存の関係に対する評価を開始したり、有効期限を更新したり、フォローアップ設定を調整したりできます。
- ベンダーとの関係を検索 — タグ、ドメイン、ステータス、リスクレベル、スコア範囲、事業部門、日付で関係を絞り込めます。
- ベンダーをオンボーディングまたはオフボーディング — 承認の概要とライフサイクル設定を指定して関係をオンボーディングするか、オフボーディングしてアーカイブできます。
- 監査ログを確認 — 日付範囲を指定して、ユーザー、組織、評価、関係に関する監査イベントを照会できます。
- インテリジェンスレポートを管理 — ベンダーのドメインに関するBitSight、SecurityScorecard、Recorded Futureのレポートを作成、更新、取得できます。
ドキュメント
VISO TRUST MCP Server
AI アシスタントと VISO TRUST API の機能を連携するための 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 プロファイルの主な違い:
- 標準入出力ではなく、ポート
3001でサーブレット Web アプリケーション(Tomcat)として実行 - MCP エンドポイント
POST /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 サーバーをリモートサーバーまたはクラウド環境にデプロイする場合
- クライアントが直接 stdio ではなく Streamable HTTP 経由で接続する場合
- 分散デプロイ向けに拡張ログ機能と監視機能が必要な場合
- Streamable HTTP 経由で接続する Web ベースの AI アシスタントと連携する場合
ローカル開発や stdio による直接通信には、デフォルトプロファイルを使用してください(プロファイルの指定は不要です)。
インストール
クイックインストール
以下のボタンのいずれかをクリックして、VS Code に VISO MCP Server をインストールします。
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 の実行
- MCP Server の Jar ファイルをビルド
./gradlew bootJar
- 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
新しいリリースが作成されると、次の処理を行います。
- build.gradle のプロジェクトバージョンをリリースタグに合わせて更新
- リリースタグのバージョンを使用して、JAR ファイルを GitHub リリースにアップロード
- Docker イメージをビルドし、次のタグを付けて Docker Hub にプッシュ
latest- リリースタグ(例:
v1.0.0)
公開に必要なシークレット
Docker Hub への公開を有効にするには、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: この関係を分類するタグの一覧(string[]、任意)
- thirdPartyContact: サードパーティベンダーの担当者の連絡先情報(object、任意)
作成された関係の詳細を返します。
create_relationship_by_domain - ベンダードメインのみを使用して新しい関係を作成する
- domain: ベンダーのドメイン(例:
visotrust.com)(string、必須) - vendorName: ベンダー名(string、必須)
- product: ベンダーが提供する製品(string、任意)
- description: ベンダーとの関係の説明(string、任意)
作成された関係の詳細を返します。
update_relationship - サードパーティベンダーとの既存の関係を更新する
- id: 関係 ID(number、必須)
- name: 関係/ベンダー名(string、必須)
- homepage: ベンダーのホームページ URL(string、任意)
- description: 関係/ベンダーの説明(string、任意)
- contextTypes: ビジネスコンテキストタイプのリスト(object[]、任意)
- dataTypes: この関係で取り扱うデータタイプのリスト(object[]、任意)
- businessOwnerEmail: ビジネスオーナーのメールアドレス(string、任意)
- businessOwnerFirstName: ビジネスオーナーの名(string、任意)
- businessOwnerLastName: ビジネスオーナーの姓(string、任意)
- tags: タグのリスト(string[]、任意)
更新された関係の詳細を返します。
partially_update_relationship - 既存の関係を部分的に更新する
update_relationship と同じフィールドを受け付けます。リクエストで指定されたフィールドのみが変更され、その他のフィールドは変更されません。
更新された関係の詳細を返します。
search_relationships - フィルター条件で関係を検索する
POST /api/v1/relationships/search を呼び出します。すべてのフィルターは任意です。フィルターは AND で結合され、1 つのリストフィルター内の値は OR で結合されます。
- request: 検索フィルター(object、任意)
- tags: VISO TRUST に表示されるとおりのタグ名(string[]、任意)
- domains: ベンダーのドメイン名(例:
example.com)(string[]、任意) - name: 関係の完全一致名(string、任意)
- externalId: 外部 ID の完全一致(string、任意)
- statuses: 関係のステータス —
NOT_ONBOARDED、ONBOARDED、ARCHIVED(string[]、任意) - assessmentStatuses: 最新の評価ステータス(string[]、任意)
- riskAcceptanceStatuses:
RISK_ACCEPTED、REVIEW_NEEDED、REMEDIATION_REQUESTED(string[]、任意) - inherentRiskLevels / residualRiskLevels:
NO_CONTEXT、LOW、MEDIUM、HIGH、EXTREME(string[]、任意) - minScore / maxScore: スコア範囲(両端を含む)(number、任意)
- businessUnitIds:
get_all_business_unitsのビジネスユニット ID(number[]、任意) - businessOwnerIds / creatorIds:
get_all_usersのユーザー ID(number[]、任意) - createdAfter / createdBefore、onboardedAfter / onboardedBefore、recertificationAfter / recertificationBefore、assessmentCompletedAfter / assessmentCompletedBefore: ISO-8601 日時(string、任意)
- page: 0 から始まるページ番号(number、任意、デフォルト 0)
- size: ページサイズ(number、任意、デフォルト 100、最大 500)
- sort:
property,asc|descによる並べ替え順。プロパティはname、externalId、score、createdDate、onboardedDate、recertificationDate(string[]、任意)
totalCount、page、size、hasMore と、一致する relationships のページを返します。
create_tags - 関係を分類するための新しいタグを作成する
- tags: 作成するタグ名のリスト(string[]、必須)
新しく作成されたタグを含むすべてのタグのリストを返します。
update_third_party_contact - サードパーティベンダーの連絡先情報を更新する
- relationshipId: 関係 ID(number、必須)
- email: 連絡先メールアドレス(string、必須)
- firstName: 連絡先の名(string、必須)
- lastName: 連絡先の姓(string、必須)
更新された関係の詳細を返します。
onboard_relationship - 承認概要とライフサイクル管理設定を任意で指定して関係をオンボーディングする
- id: 関係 ID(number、必須)
- approvalSummary: オンボーディング時に記録する任意の承認概要(string、任意)
- lifecycleManagementUpdateRequest: 任意のライフサイクル管理設定(object、任意)
- artifactUpdateSettings.artifactUpdateType: アーティファクトの更新タイプ(string enum)
- recertificationSettings.recertificationType: 再認証タイプ(string enum)
- recertificationSettings.recertificationDate: 次回再認証の日時。オフセット付き ISO-8601(string)
- recertificationSettings.reviewFrequency:
THREE_YEARS、TWO_YEARS、ANNUAL、SEMIANNUAL、またはQUARTERLY(string enum)
オンボーディングされた関係の詳細を返します。
offboard_relationship - 関係をオフボーディングする
- id: 関係 ID(number、必須)
オフボーディングされた関係の詳細を返します。
accept_relationship_risk - 関係のリスクを受容する
- id: 関係 ID(number、必須)
- request:(object、任意)
- riskReviewNote: 判断の理由を説明するメモ(string、任意)
- inherentRiskOverride / residualRiskOverride:
LOW、MEDIUM、HIGH、またはEXTREME。両方を指定するか、どちらも指定しないでください(string、任意)
更新された関係を返します。
get_relationship_detections - 関係のエビデンスで検出された項目を取得する
- id: 関係 ID(number、必須)
- detectionTypes:
NORMAL、SUBSERVICE、SHARED_RESPONSIBILITY_MODEL、EXCEPTION、CUEC、SUBPROCESSOR。デフォルトではNORMALを除くすべて(string[]、任意) - controlDomainTypes: 含めるコントロールドメインタイプ。デフォルトではすべて(string[]、任意)
- assessmentId: この関係の完了済み評価、または進行中の最新の評価(number、任意)
- includeQuestionnaireAnswers: 補足質問票の検出項目の根拠となる回答を含める(boolean、任意)
- afterId: 前のページの
nextAfterId(number、任意) - size: 1~500 件の検出項目(number、任意、デフォルト 100)
検出項目の 1 ページ分を返します。nextAfterId が null でない場合は、続けて読み取ってください。
get_risk_advisories_by_relationship - 関係のベンダーに関するリスク勧告を取得する
- id: 関係 ID(number、必須)
archive_relationship - 関係をアーカイブする
- id: 関係 ID(number、必須)
アーカイブされた関係の詳細を返します。
Webhooks
get_all_webhooks - すべての Webhook を取得する
パラメーターは不要です。
すべての Webhook 設定のリストを返します。
get_webhook - ID で Webhook 設定を取得する
- id: Webhook ID(number、必須)
指定した Webhook 設定の詳細を返します。
create_webhook_configuration - Webhook 設定を作成する
- request: Webhook 作成パラメーター(object、必須)
- url: Webhook URL(string、必須)
- secret: Webhook シークレット(string、必須)
- eventTypes: Webhook をトリガーするイベントタイプ(string[]、必須)
- serviceType: Webhook のサービスの種類(string、必須)
作成された Webhook 設定を返します。
update_webhook_configuration - Webhook 設定を更新する
- request: Webhook 更新パラメーター(object、必須)
- id: Webhook ID(number、必須)
- url: Webhook URL(string、任意)
- secret: Webhook シークレット(string、任意)
- eventTypes: Webhook をトリガーするイベントタイプ(string[]、任意)
- serviceType: Webhook のサービスの種類(string、任意)
更新された Webhook 設定を返します。
delete_webhook_configuration - Webhook 設定を削除する
- id: Webhook ID(number、必須)
指定した Webhook 設定を削除します。
インテリジェンスレポート
create_bitsight_intelligence_report - 新しい BitSight インテリジェンスレポートを作成する
- request: BitSight レポートのパラメーター(object、必須)
- vendorDomain: ベンダーのプライマリドメイン名(string、必須)
- reportDate: レポートが生成された日時(ISO 8601 string、必須)
- link: プロバイダーの UI への任意のリンク(string、任意)
- guid: エンティティの BitSight GUID(string、必須)
- customId: BitSight のカスタム識別子(string、任意)
- name: BitSight エンティティの表示名(string、任意)
- description: BitSight エンティティの説明(string、任意)
- primaryDomain: BitSight エンティティのプライマリドメイン(string、任意)
- ratingRange: BitSight の評価範囲(string、任意)
- ratingColor: BitSight の評価色(string、任意)
- confidence: BitSight 評価の信頼度(string、任意)
作成されたインテリジェンスレポートを返します。
create_security_scorecard_intelligence_report - 新しい SecurityScorecard インテリジェンスレポートを作成する
- request: SecurityScorecard レポートのパラメーター(object、必須)
- vendorDomain: ベンダーのプライマリドメイン名(string、必須)
- reportDate: レポートが生成された日時(ISO 8601 string、必須)
- link: プロバイダーの UI への任意のリンク(string、任意)
- grade: SecurityScorecard のレターグレード(string、必須)
- domain: スコアカードエンティティに関連付けられたドメイン(string、任意)
- score: SecurityScorecard の数値スコア(number、任意)
作成されたインテリジェンスレポートを返します。
create_recorded_future_intelligence_report - 新しい Recorded Future インテリジェンスレポートを作成する
- request: Recorded Future レポートのパラメーター(object、必須)
- vendorDomain: ベンダーのプライマリドメイン名(string、必須)
- reportDate: レポートが生成された日時(ISO 8601 string、必須)
- entityType: Recorded Future のエンティティタイプ(例:
Company)(string、必須) - entity: Recorded Future のエンティティ識別子(string、必須)
- riskScore: 数値のリスクスコア(number、必須)
- riskLevel: リスクレベルのラベル(例:
Critical/High/Medium/Low)(string、必須) - link: プロバイダーの UI にあるレポートへの任意のリンク(string、任意)
- firstSeen: エンティティが最初に観測された日付(ISO 8601)(string、任意)
- lastSeen: エンティティが最後に観測された日付(ISO 8601)(string、任意)
- triggeredRuleCount: トリガーされた Recorded Future ルールの数(number、任意)
- maxRuleCount: 評価された Recorded Future ルールの最大数(number、任意)
- summary: Recorded Future の任意の概要テキスト(string、任意)
- criticalityLabel: エンティティに対する Recorded Future の重要度ラベル(string、任意)
作成されたインテリジェンスレポートを返します。
get_intelligence_reports_by_vendor - ベンダーのすべてのインテリジェンスレポートを取得する
- vendorDomain: ベンダーのプライマリドメイン名(string、必須)
指定したベンダーのインテリジェンスレポートのリストを返します。
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ツールと同じフィールド(object[]、必須)
totalCount、created 件のレポート ID、およびバックグラウンドでの作成待ちとなったレポートの backgroundedCount を返します。
get_latest_intelligence_report - 特定のソースからベンダーの最新インテリジェンスレポートを取得する
- vendorDomain: ベンダーのプライマリドメイン名(string、必須)
- source: インテリジェンスプロバイダー(string enum:
BITSIGHT、SECURITY_SCORECARD、またはRECORDED_FUTURE、必須)
指定したベンダーとソースの最新インテリジェンスレポートを返します。
リスク勧告
get_risk_advisories_by_vendor - ベンダーのすべてのリスク勧告を取得する
- vendorId: ベンダー ID(number、必須)
ベンダー向けに公開されたセキュリティ、コンプライアンス、脆弱性、法務、地政学、財務、運用に関する勧告を返します。
ユーザー
get_all_users - 組織内のすべてのユーザーを取得
- page: 取得する結果ページ(数値、省略可、デフォルトは0)
- size: 1ページあたりのレコード数(数値、省略可、デフォルトは20)
- sort: 次の形式の並べ替え条件: property(,asc|desc)(文字列、省略可)
ページ分割されたユーザーの一覧を返します。
get_user_by_email - メールアドレスでユーザーを取得
- email: ユーザーのメールアドレス(文字列、必須)
ユーザーの詳細を返します。
create_user - 新しいユーザーを作成
- request: ユーザー作成パラメーター(オブジェクト、必須)
- email: 新しいユーザーのメールアドレス(文字列、必須)
- firstName: 新しいユーザーの名(文字列、必須)
- lastName: 新しいユーザーの姓(文字列、必須)
作成したユーザーを返します。
コードのフォーマット
このプロジェクトでは、コードのフォーマットに Google Java Format を使用する Spotless を採用しています。一貫したコードスタイルを保つため、pre-commit フックが自動的に設定されます。
セットアップ
リポジトリをクローンした後、Gradle コマンドを実行すると pre-commit フックが自動的に設定されます。
手動でのフォーマット
すべてのファイルを手動でフォーマットするには:
./gradlew spotlessApply
ファイルが正しくフォーマットされているか確認するには:
./gradlew spotlessCheck
フォーマットの問題により pre-commit フックがコミットを拒否した場合は、./gradlew spotlessApply を実行してフォーマットを修正してから、もう一度コミットしてください。
ライセンス
このプロジェクトは MIT License の下でライセンスされています。詳細については LICENSE ファイルを参照してください。