VISO TRUST
ทางการเข้าถึงและจัดการโปรแกรมความเสี่ยงจากบุคคลที่สามของ VISO TRUST ของคุณโดยตรงผ่านผู้ช่วย AI ของคุณ
คุณทำอะไรได้บ้างด้วย VISO TRUST MCP?
- ค้นหาการประเมินผู้ขาย — เรียกดูการประเมินที่ระบุด้วย ID รวมถึงสรุปที่สร้างโดย AI ในรูปแบบ HTML หรือ Markdown
- สร้างและจัดการการประเมิน — เริ่มการประเมินสำหรับความสัมพันธ์ที่มีอยู่ อัปเดตวันหมดอายุ หรือปรับการตั้งค่าการติดตามผล
- ค้นหาความสัมพันธ์กับผู้ขาย — กรองความสัมพันธ์ตามแท็ก โดเมน สถานะ ระดับความเสี่ยง ช่วงคะแนน หน่วยธุรกิจ และวันที่
- เริ่มต้นหรือยุติความสัมพันธ์กับผู้ขาย — เริ่มต้นความสัมพันธ์พร้อมสรุปการอนุมัติและการตั้งค่าวงจรชีวิต หรือยุติความสัมพันธ์และเก็บถาวร
- ตรวจสอบบันทึกการตรวจสอบ — ค้นหาเหตุการณ์การตรวจสอบของผู้ใช้ องค์กร การประเมิน และความสัมพันธ์ภายในช่วงวันที่
- จัดการรายงานข่าวกรอง — สร้าง อัปเดต หรือดึงรายงาน BitSight, SecurityScorecard และ Recorded Future สำหรับโดเมนของผู้ขาย
เอกสาร
VISO TRUST MCP Server
เซิร์ฟเวอร์ Model Context Protocol (MCP) สำหรับผสานความสามารถของ VISO TRUST API เข้ากับผู้ช่วย AI
เซิร์ฟเวอร์ระยะไกลที่โฮสต์ไว้
VISO TRUST โฮสต์อินสแตนซ์ที่มีการจัดการของเซิร์ฟเวอร์ MCP นี้ คุณจึงเริ่มต้นใช้งานได้โดยไม่ต้องสร้าง เรียกใช้ หรือโฮสต์เอง:
https://mcp.visotrust.com/mcp
เชื่อมต่อไคลเอ็นต์ MCP ใดก็ได้กับปลายทางนี้โดยใช้การขนส่ง Streamable HTTP และยืนยันตัวตนด้วยโทเค็น API ของ VISO TRUST ดูข้อมูลเกี่ยวกับวิธีสร้างโทเค็น 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: URL พื้นฐานสำหรับ VISO TRUST API (ค่าเริ่มต้น: http://localhost:8080)visotrust.api.token: โทเค็น API ของคุณจากแพลตฟอร์ม VISO TRUST (จำเป็น)visotrust.api.timeout: ระยะหมดเวลาของคำขอ API เป็นมิลลิวินาที (ค่าเริ่มต้น: 30000)visotrust.api.connect-timeout: ระยะหมดเวลาการเชื่อมต่อ API เป็นมิลลิวินาที (ค่าเริ่มต้น: 5000)
ดูข้อมูลเกี่ยวกับวิธีสร้างโทเค็น API สำหรับตัวแปรสภาพแวดล้อม visotrust.api.token ได้ที่ เอกสารสนับสนุน VISO TRUST
โปรไฟล์แอปพลิเคชัน
แอปพลิเคชันนี้รองรับโปรไฟล์ Spring Boot เพื่อเปิดใช้การกำหนดค่าที่แตกต่างกันสำหรับสถานการณ์การติดตั้งใช้งานที่แตกต่างกัน
โปรไฟล์ Remote
โปรไฟล์ remote ออกแบบมาสำหรับ การรองรับ MCP ระยะไกลผ่านการขนส่ง Streamable HTTP โปรไฟล์นี้เรียกใช้เซิร์ฟเวอร์เป็นเว็บแอปพลิเคชันเพื่อให้สื่อสารกับไคลเอ็นต์ระยะไกลผ่าน HTTP ได้ (Streamable HTTP มาแทนการขนส่ง SSE ที่เลิกใช้งานแล้ว โดยกำหนดค่าให้ทำงานในโหมดไร้สถานะ)
ความแตกต่างที่สำคัญของโปรไฟล์ remote:
- ทำงานเป็นเว็บแอปพลิเคชันแบบ servlet (Tomcat) บนพอร์ต
3001แทน standard I/O - เปิดเผยปลายทาง MCP ที่
POST /mcp(Streamable HTTP) - ทำงานในโหมด ไร้สถานะ — ไม่มีสถานะเซิร์ฟเวอร์แยกตามเซสชัน จึงปรับขนาดในแนวนอนหลัง load balancer ได้โดยไม่ต้องกำหนด session affinity
- ปรับการตั้งค่าเซิร์ฟเวอร์ให้เหมาะกับการเชื่อมต่อจากไคลเอ็นต์ระยะไกล
- เพิ่มประสิทธิภาพการบันทึกล็อกเพื่อช่วยดีบักระบบแบบกระจาย
หมายเหตุ: ไคลเอ็นต์เชื่อมต่อกับปลายทาง 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 โดยตรง
- ต้องการการบันทึกล็อกและการตรวจสอบที่ดียิ่งขึ้นสำหรับการติดตั้งใช้งานแบบกระจาย
- ผสานการทำงานกับผู้ช่วย AI บนเว็บที่เชื่อมต่อผ่าน Streamable HTTP
สำหรับการพัฒนาในเครื่องและการสื่อสารผ่าน stdio โดยตรง ให้ใช้โปรไฟล์เริ่มต้น (ไม่จำเป็นต้องระบุโปรไฟล์)
การติดตั้ง
ติดตั้งอย่างรวดเร็ว
คลิกปุ่มใดปุ่มหนึ่งด้านล่างเพื่อติดตั้ง VISO MCP Server ใน VS Code:
ตั้งค่าด้วยตนเองใน VS Code
เพิ่มบล็อก JSON ต่อไปนี้ลงในไฟล์ User Settings (JSON) ใน VS Code โดยกด 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 ใน workspace ได้ วิธีนี้จะช่วยให้คุณแชร์การกำหนดค่ากับผู้อื่นได้
{
"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 Image
docker build -t viso-mcp-server .
เรียกใช้ Docker Container
docker run -i --rm -e VISOTRUST_API_TOKEN=<your-api-token> viso-mcp-server
การดีบัก
ติดตั้ง MCP Inspector
npm -g install @modelcontextprotocol/inspector
เรียกใช้ MCP Inspector เพื่อทดสอบ
- สร้างไฟล์ Jar ของ MCP Server
./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 image ไปยัง Docker Hub พร้อมแท็ก:
latest- แท็กรีลีส (เช่น
v1.0.0)
Secrets ที่จำเป็นสำหรับการเผยแพร่
หากต้องการเปิดใช้การเผยแพร่ไปยัง Docker Hub ให้เพิ่ม secrets เหล่านี้ใน GitHub repository ของคุณ:
DOCKERHUB_USERNAME: ชื่อผู้ใช้ Docker Hub ของคุณDOCKERHUB_TOKEN: โทเค็นการเข้าถึง Docker Hub ของคุณ
🛠️ เครื่องมือ
ส่วนนี้อธิบายเครื่องมือที่ VISO MCP Server เปิดให้ใช้งาน เครื่องมือแต่ละรายการมีวัตถุประสงค์ พารามิเตอร์อินพุต และรูปแบบเอาต์พุตเฉพาะ
การประเมิน
get_assessment - ดึงข้อมูลการประเมินตาม ID
- id: ID การประเมิน (number, required)
ส่งคืนข้อมูลโดยละเอียดเกี่ยวกับการประเมินที่ระบุ
get_assessment_summary - ดึงข้อมูลสรุปของการประเมินตาม ID
- id: ID การประเมิน (number, required)
- format:
HTML(ค่าเริ่มต้น) หรือMARKDOWN(string, optional)
ส่งคืนข้อมูลสรุป ค่า version และระบุว่ามีการ edited แล้วหรือไม่
update_assessment_summary - แทนที่ข้อความสรุปที่ AI สร้างขึ้นสำหรับการประเมินที่เสร็จสมบูรณ์แล้ว
- id: ID การประเมิน (number, required)
- summary: ข้อความสรุปที่แก้ไขแล้ว (string, required)
- format:
HTML(ค่าเริ่มต้น) หรือMARKDOWN(string, optional) - version: ค่า
versionจากget_assessment_summary; ระบบจะปฏิเสธการอัปเดตหากข้อความสรุปมีการเปลี่ยนแปลงนับจากนั้น (string, optional)
ส่งคืนข้อความสรุปที่อัปเดตแล้วในรูปแบบเดียวกับที่ส่งมา
create_assessment - เริ่มการประเมินสำหรับความสัมพันธ์ที่มีอยู่
- relationshipId: ID ของความสัมพันธ์ที่จะสร้างการประเมิน (number, required)
- recipientEmail: อีเมลของผู้รับการประเมิน (string, optional)
- recipientFirstName: ชื่อของผู้รับการประเมิน (string, optional)
- recipientLastName: นามสกุลของผู้รับการประเมิน (string, optional)
- publicDocumentUrls: URL ของเอกสารสาธารณะที่จะรวมไว้ในการประเมิน (string[], optional)
- followupType: ประเภทการติดตามผล (string enum, optional)
- followupRiskThreshold: ระดับความเสี่ยงที่ใช้เป็นเกณฑ์ในการติดตามผล (string enum, optional)
- followupTimeline: กำหนดเวลาสำหรับการดำเนินการติดตามผล (string enum, optional)
- collectionTimeline: กำหนดเวลาที่ผู้ขายต้องส่งแบบประเมินให้เสร็จ (string enum, optional)
- noVendorResponseAction: การดำเนินการเมื่อผู้ขายไม่ตอบกลับ (string enum, optional)
- aiProcessingOnly: ระบุว่าจะประมวลผลด้วย AI เท่านั้นโดยไม่มีการตรวจสอบจากมนุษย์หรือไม่ (boolean, optional)
- requestedAuditTypes: ประเภทการตรวจสอบที่ร้องขอสำหรับการประเมินนี้ (string[], optional)
ส่งคืนรายละเอียดการประเมินที่สร้างขึ้น
update_assessment_expiration_date - อัปเดตกำหนดเวลาที่ผู้ขายต้องส่งคำตอบการประเมิน
- id: ID การประเมิน (number, required)
- expirationDate: วันและเวลาหมดอายุใหม่ รูปแบบ ISO-8601 พร้อม offset และต้องเป็นเวลาในอนาคต (string, required)
ส่งคืนข้อความยืนยัน
update_assessment_followup - อัปเดตการกำหนดค่าการติดตามผลสำหรับการประเมิน
- id: ID การประเมิน (number, required)
- followupType: ประเภทการติดตามผล (string enum, required)
- followupRiskThreshold: เกณฑ์ความเสี่ยงที่ระดับดังกล่าวหรือสูงกว่าจะทำให้เริ่มการประเมินติดตามผล (string enum, optional)
- followupTimeline: กำหนดเวลาการติดตามผล (string enum, optional)
ส่งคืนข้อความยืนยัน
บันทึกการตรวจสอบ
get_user_audit_log_events - ดึงเหตุการณ์บันทึกการตรวจสอบระดับผู้ใช้สำหรับองค์กรของคุณ
- start: วันและเวลาเริ่มต้นของการค้นหา รูปแบบ ISO-8601 พร้อม offset (string, required)
- end: วันและเวลาสิ้นสุดของการค้นหา รูปแบบ ISO-8601 พร้อม offset (string, required)
- eventTypes: ชุดประเภทเหตุการณ์ที่ใช้กรอง (ไม่บังคับ) (เช่น
USER_LOGGED_IN); เว้นว่างไว้เพื่อดึงทั้งหมด (string[], optional)
ส่งคืนรายการเหตุการณ์บันทึกการตรวจสอบของผู้ใช้ โดยจำกัดไม่เกิน 500 รายการ
get_audit_log_events - ดึงเหตุการณ์บันทึกการตรวจสอบที่กรองแล้ว (เหตุการณ์ผู้ใช้ องค์กร การประเมิน และความสัมพันธ์)
- start: วันและเวลาเริ่มต้นของการค้นหา รูปแบบ ISO-8601 พร้อม offset (string, required)
- end: วันและเวลาสิ้นสุดของการค้นหา รูปแบบ ISO-8601 พร้อม offset (string, required)
- eventTypes: ชุดประเภทเหตุการณ์ที่ใช้กรอง (ไม่บังคับ) (เช่น
ASSESSMENT_COMPLETED,RELATIONSHIP_CREATED); เว้นว่างไว้เพื่อดึงทั้งหมด (string[], optional)
ส่งคืนระเบียนเหตุการณ์บันทึกการตรวจสอบแบบ polymorphic แต่ละรายการมีอย่างน้อย auditEventType และ dateTime
หน่วยธุรกิจ
get_all_business_units - ดึงหน่วยธุรกิจทั้งหมดขององค์กร เรียงตามชื่อ
ส่งคืน id ของแต่ละหน่วยธุรกิจ (ใช้เป็นตัวกรอง businessUnitIds ใน search_relationships ได้) และ name (ใช้เป็น businessUnit ใน create_user ได้)
กรณีธุรกิจ
get_all_business_cases - ดึงกรณีธุรกิจทั้งหมดที่มีให้ใช้งานสำหรับองค์กรของคุณ
ไม่ต้องใช้พารามิเตอร์
ส่งคืนรายการกรณีธุรกิจทั้งหมดที่มีให้ใช้งานสำหรับองค์กรของคุณ
ประเภทข้อมูล
get_all_datatypes - ดึงประเภทข้อมูลทั้งหมดที่มีให้ใช้งานสำหรับองค์กรของคุณ
ไม่ต้องใช้พารามิเตอร์
ส่งคืนรายการประเภทข้อมูลทั้งหมดที่มีให้ใช้งานสำหรับองค์กรของคุณ
ไดเรกทอรีผู้ขาย
search_vendor_directory - ค้นหาผู้ขายในไดเรกทอรีผู้ขาย VISO TRUST ด้วย URL หรือโดเมน
- urlOrDomain: URL หรือชื่อโดเมนที่ต้องการค้นหา เช่น
example.com(string, required)
ส่งคืนข้อมูลเมตาพื้นฐานของผู้ขาย (ชื่อ หน้าแรก คำอธิบาย favicon และโดเมนที่รู้จัก)
ความสัมพันธ์
get_all_relationships - ดึงรายการความสัมพันธ์ทั้งหมดและรายละเอียดการประเมินของแต่ละรายการ
ไม่ต้องใช้พารามิเตอร์
ส่งคืนข้อมูลเกี่ยวกับผู้ขายบุคคลที่สาม รวมถึงสถานะการประเมิน ระดับความเสี่ยง และรายละเอียดการติดต่อ
get_relationship_by_id - ดึงความสัมพันธ์ที่ระบุและรายละเอียดการประเมินตาม ID
- id: ID ความสัมพันธ์ (number, required)
ส่งคืนข้อมูลโดยละเอียดเกี่ยวกับผู้ขายบุคคลที่สาม รวมถึงสถานะการประเมิน ระดับความเสี่ยง และรายละเอียดการติดต่อ
get_relationship_assessment_history - ดึงประวัติการประเมินของความสัมพันธ์
- id: ID ความสัมพันธ์ (number, required)
ส่งคืนรายการการประเมินที่เกี่ยวข้องกับความสัมพันธ์ที่ระบุ
create_relationship - สร้างความสัมพันธ์ใหม่กับผู้ขายบุคคลที่สาม
- name: ชื่อความสัมพันธ์/ผู้ขาย (string, required)
- homepage: URL หน้าแรกของผู้ขาย (string, required)
- businessOwnerEmail: อีเมลของเจ้าของธุรกิจ (string, required)
- businessOwnerFirstName: ชื่อของเจ้าของธุรกิจ (string, optional)
- businessOwnerLastName: นามสกุลของเจ้าของธุรกิจ (string, optional)
- description: คำอธิบายความสัมพันธ์/ผู้ขาย (string, optional)
- contextTypes: รายการประเภทบริบททางธุรกิจสำหรับความสัมพันธ์นี้ (object[], optional)
- dataTypes: รายการประเภทข้อมูลที่จัดการในความสัมพันธ์นี้ (object[], optional)
- tags: รายการแท็กสำหรับจัดหมวดหมู่ความสัมพันธ์นี้ (string[], optional)
- thirdPartyContact: รายละเอียดการติดต่อของตัวแทนผู้ขายบุคคลที่สาม (object, optional)
ส่งคืนรายละเอียดความสัมพันธ์ที่สร้างขึ้น
create_relationship_by_domain - สร้างความสัมพันธ์ใหม่โดยใช้เฉพาะโดเมนของผู้ขาย
- domain: โดเมนของผู้ขาย เช่น
visotrust.com(string, required) - vendorName: ชื่อผู้ขาย (string, required)
- product: ผลิตภัณฑ์ที่ผู้ขายนำเสนอ (string, optional)
- description: คำอธิบายความสัมพันธ์กับผู้ขาย (string, optional)
ส่งคืนรายละเอียดความสัมพันธ์ที่สร้างขึ้น
update_relationship - อัปเดตความสัมพันธ์ที่มีอยู่กับผู้ขายบุคคลที่สาม
- id: ID ความสัมพันธ์ (number, required)
- name: ชื่อความสัมพันธ์/ผู้ขาย (string, required)
- homepage: URL หน้าแรกของผู้ขาย (string, optional)
- description: คำอธิบายความสัมพันธ์/ผู้ขาย (string, optional)
- contextTypes: รายการประเภทบริบททางธุรกิจ (object[], optional)
- dataTypes: รายการประเภทข้อมูลที่จัดการในความสัมพันธ์นี้ (object[], optional)
- businessOwnerEmail: ที่อยู่อีเมลของเจ้าของธุรกิจ (string, optional)
- businessOwnerFirstName: ชื่อของเจ้าของธุรกิจ (string, optional)
- businessOwnerLastName: นามสกุลของเจ้าของธุรกิจ (string, optional)
- tags: รายการแท็ก (string[], optional)
ส่งคืนรายละเอียดความสัมพันธ์ที่อัปเดตแล้ว
partially_update_relationship - อัปเดตความสัมพันธ์ที่มีอยู่บางส่วน
รับฟิลด์เดียวกันกับ update_relationship โดยจะเปลี่ยนเฉพาะฟิลด์ที่ระบุในคำขอ ส่วนฟิลด์อื่นจะคงเดิม
ส่งคืนรายละเอียดความสัมพันธ์ที่อัปเดตแล้ว
search_relationships - ค้นหาความสัมพันธ์ตามเกณฑ์ตัวกรอง
เรียกใช้ POST /api/v1/relationships/search ตัวกรองทั้งหมดเป็นตัวเลือก โดยตัวกรองจะรวมกันด้วย AND และค่าภายในตัวกรองแบบรายการเดียวกันจะรวมกันด้วย OR
- request: ตัวกรองการค้นหา (object, optional)
- tags: ชื่อแท็กตามที่ปรากฏใน VISO TRUST ทุกประการ (string[], optional)
- domains: ชื่อโดเมนของผู้ขาย เช่น
example.com(string[], optional) - name: ชื่อความสัมพันธ์ที่ตรงกันทุกประการ (string, optional)
- externalId: external id ที่ตรงกันทุกประการ (string, optional)
- statuses: สถานะความสัมพันธ์ —
NOT_ONBOARDED,ONBOARDED,ARCHIVED(string[], optional) - assessmentStatuses: สถานะการประเมินล่าสุด (string[], optional)
- riskAcceptanceStatuses:
RISK_ACCEPTED,REVIEW_NEEDED,REMEDIATION_REQUESTED(string[], optional) - inherentRiskLevels / residualRiskLevels:
NO_CONTEXT,LOW,MEDIUM,HIGH,EXTREME(string[], optional) - minScore / maxScore: ช่วงคะแนน รวมค่าขอบเขตด้วย (number, optional)
- businessUnitIds: ID หน่วยธุรกิจจาก
get_all_business_units(number[], optional) - businessOwnerIds / creatorIds: ID ผู้ใช้จาก
get_all_users(number[], optional) - createdAfter / createdBefore, onboardedAfter / onboardedBefore, recertificationAfter / recertificationBefore, assessmentCompletedAfter / assessmentCompletedBefore: วันและเวลา ISO-8601 (string, optional)
- page: หมายเลขหน้าเริ่มจากศูนย์ (number, optional, default 0)
- size: ขนาดหน้า (number, optional, default 100, max 500)
- sort: ลำดับการจัดเรียงตาม
property,asc|desc; คุณสมบัติname,externalId,score,createdDate,onboardedDate,recertificationDate(string[], optional)
ส่งคืน totalCount, page, size, hasMore และหน้าของ relationships ที่ตรงกัน
create_tags - สร้างแท็กใหม่เพื่อจัดหมวดหมู่ความสัมพันธ์
- tags: รายการชื่อแท็กที่จะสร้าง (string[], required)
ส่งคืนรายการแท็กทั้งหมด รวมถึงแท็กที่สร้างใหม่
update_third_party_contact - อัปเดตรายละเอียดการติดต่อของผู้ขายบุคคลที่สาม
- relationshipId: ID ความสัมพันธ์ (number, required)
- email: อีเมลติดต่อ (string, required)
- firstName: ชื่อผู้ติดต่อ (string, required)
- lastName: นามสกุลผู้ติดต่อ (string, required)
ส่งคืนรายละเอียดความสัมพันธ์ที่อัปเดตแล้ว
onboard_relationship - เริ่มใช้งานความสัมพันธ์ โดยอาจระบุสรุปการอนุมัติและการตั้งค่าการจัดการวงจรชีวิต
- id: ID ความสัมพันธ์ (number, required)
- approvalSummary: สรุปการอนุมัติที่บันทึกไว้ขณะเริ่มใช้งาน (string, optional)
- lifecycleManagementUpdateRequest: การตั้งค่าการจัดการวงจรชีวิต (object, optional)
- artifactUpdateSettings.artifactUpdateType: ประเภทการอัปเดตอาร์ติแฟกต์ (string enum)
- recertificationSettings.recertificationType: ประเภทการรับรองซ้ำ (string enum)
- recertificationSettings.recertificationDate: วันที่/เวลาของการรับรองซ้ำครั้งถัดไป รูปแบบ ISO-8601 พร้อม offset (string)
- recertificationSettings.reviewFrequency:
THREE_YEARS,TWO_YEARS,ANNUAL,SEMIANNUALหรือQUARTERLY(string enum)
ส่งคืนรายละเอียดความสัมพันธ์ที่เริ่มใช้งานแล้ว
offboard_relationship - ยุติความสัมพันธ์
- id: ID ความสัมพันธ์ (number, required)
ส่งคืนรายละเอียดความสัมพันธ์ที่ยุติแล้ว
accept_relationship_risk - ยอมรับความเสี่ยงของความสัมพันธ์
- id: ID ความสัมพันธ์ (number, required)
- request: (object, optional)
- riskReviewNote: หมายเหตุอธิบายการตัดสินใจ (string, optional)
- inherentRiskOverride / residualRiskOverride:
LOW,MEDIUM,HIGHหรือEXTREME; ต้องระบุทั้งคู่หรือไม่ระบุเลย (string, optional)
ส่งคืนความสัมพันธ์ที่อัปเดตแล้ว
get_relationship_detections - ดูการตรวจพบที่พบในหลักฐานของความสัมพันธ์
- id: ID ความสัมพันธ์ (number, required)
- detectionTypes:
NORMAL,SUBSERVICE,SHARED_RESPONSIBILITY_MODEL,EXCEPTION,CUEC,SUBPROCESSOR; ค่าเริ่มต้นคือทั้งหมด ยกเว้นNORMAL(string[], optional) - controlDomainTypes: ประเภทโดเมนการควบคุมที่จะรวม ค่าเริ่มต้นคือทั้งหมด (string[], optional)
- assessmentId: การประเมินความสัมพันธ์นี้ที่เสร็จสมบูรณ์แล้ว หรือการประเมินล่าสุดที่กำลังดำเนินการอยู่ (number, optional)
- includeQuestionnaireAnswers: รวมคำตอบที่อยู่เบื้องหลังการตรวจพบจากแบบสอบถามเพิ่มเติม (boolean, optional)
- afterId:
nextAfterIdของหน้าก่อนหน้า (number, optional) - size: จำนวนการตรวจพบต่อหน้า ตั้งแต่ 1 ถึง 500 (number, optional, default 100)
ส่งคืนการตรวจพบหนึ่งหน้า ให้อ่านต่อขณะที่ nextAfterId ไม่เป็น null
get_risk_advisories_by_relationship - ดูคำแนะนำความเสี่ยงสำหรับผู้ขายของความสัมพันธ์
- id: ID ความสัมพันธ์ (number, required)
archive_relationship - เก็บความสัมพันธ์เข้าคลัง
- id: ID ความสัมพันธ์ (number, required)
ส่งคืนรายละเอียดความสัมพันธ์ที่เก็บเข้าคลังแล้ว
Webhooks
get_all_webhooks - ดู webhooks ทั้งหมด
ไม่ต้องใช้พารามิเตอร์
ส่งคืนรายการการกำหนดค่า webhook ทั้งหมด
get_webhook - ดูการกำหนดค่า webhook ตาม id
- id: ID ของ webhook (number, required)
ส่งคืนรายละเอียดการกำหนดค่า webhook ที่ระบุ
create_webhook_configuration - สร้างการกำหนดค่า webhook
- request: พารามิเตอร์สำหรับสร้าง webhook (object, required)
- url: URL ของ webhook (string, required)
- secret: secret ของ webhook (string, required)
- eventTypes: ประเภทเหตุการณ์ที่จะเรียกใช้ webhook (string[], required)
- serviceType: ประเภทบริการสำหรับ webhook (string, required)
ส่งคืนการกำหนดค่า webhook ที่สร้างขึ้น
update_webhook_configuration - อัปเดตการกำหนดค่า webhook
- request: พารามิเตอร์สำหรับอัปเดต webhook (object, required)
- id: ID ของ webhook (number, required)
- url: URL ของ webhook (string, optional)
- secret: secret ของ webhook (string, optional)
- eventTypes: ประเภทเหตุการณ์ที่จะเรียกใช้ webhook (string[], optional)
- serviceType: ประเภทบริการสำหรับ webhook (string, optional)
ส่งคืนการกำหนดค่า webhook ที่อัปเดตแล้ว
delete_webhook_configuration - ลบการกำหนดค่า webhook
- id: ID ของ webhook (number, required)
ลบการกำหนดค่า webhook ที่ระบุ
รายงานข่าวกรอง
create_bitsight_intelligence_report - สร้างรายงานข่าวกรอง BitSight ใหม่
- request: พารามิเตอร์รายงาน BitSight (object, required)
- vendorDomain: ชื่อโดเมนหลักของผู้ขาย (string, required)
- reportDate: วันที่/เวลาที่สร้างรายงาน (สตริง ISO 8601, required)
- link: ลิงก์ไปยัง UI ของผู้ให้บริการ (string, optional)
- guid: GUID ของเอนทิตีใน BitSight (string, required)
- customId: ตัวระบุที่กำหนดเองจาก BitSight (string, optional)
- name: ชื่อที่แสดงของเอนทิตี BitSight (string, optional)
- description: คำอธิบายเอนทิตี BitSight (string, optional)
- primaryDomain: โดเมนหลักของเอนทิตี BitSight (string, optional)
- ratingRange: ช่วงคะแนน BitSight (string, optional)
- ratingColor: สีคะแนน BitSight (string, optional)
- confidence: ระดับความเชื่อมั่นของคะแนน BitSight (string, optional)
ส่งคืนรายงานข่าวกรองที่สร้างขึ้น
create_security_scorecard_intelligence_report - สร้างรายงานข่าวกรอง SecurityScorecard ใหม่
- request: พารามิเตอร์รายงาน SecurityScorecard (object, required)
- vendorDomain: ชื่อโดเมนหลักของผู้ขาย (string, required)
- reportDate: วันที่/เวลาที่สร้างรายงาน (สตริง ISO 8601, required)
- link: ลิงก์ไปยัง UI ของผู้ให้บริการ (string, optional)
- grade: เกรดตัวอักษรของ SecurityScorecard (string, required)
- domain: โดเมนที่เชื่อมโยงกับเอนทิตี scorecard (string, optional)
- score: คะแนนตัวเลขจาก SecurityScorecard (number, optional)
ส่งคืนรายงานข่าวกรองที่สร้างขึ้น
create_recorded_future_intelligence_report - สร้างรายงานข่าวกรอง Recorded Future ใหม่
- request: พารามิเตอร์รายงาน Recorded Future (object, required)
- vendorDomain: ชื่อโดเมนหลักของผู้ขาย (string, required)
- reportDate: วันที่/เวลาที่สร้างรายงาน (สตริง ISO 8601, required)
- entityType: ประเภทเอนทิตีของ Recorded Future เช่น
Company(string, required) - entity: ตัวระบุเอนทิตีของ Recorded Future (string, required)
- riskScore: คะแนนความเสี่ยงตัวเลข (number, required)
- riskLevel: ป้ายกำกับระดับความเสี่ยง เช่น
Critical/High/Medium/Low(string, required) - link: ลิงก์ไปยังรายงานใน UI ของผู้ให้บริการ (string, optional)
- firstSeen: วันที่พบเอนทิตีครั้งแรก รูปแบบ ISO 8601 (string, optional)
- lastSeen: วันที่พบเอนทิตีล่าสุด รูปแบบ ISO 8601 (string, optional)
- triggeredRuleCount: จำนวนกฎของ Recorded Future ที่ถูกเรียกใช้ (number, optional)
- maxRuleCount: จำนวนกฎสูงสุดของ Recorded Future ที่ได้รับการประเมิน (number, optional)
- summary: ข้อความสรุปจาก Recorded Future (string, optional)
- criticalityLabel: ป้ายกำกับระดับความสำคัญของเอนทิตีใน Recorded Future (string, optional)
ส่งคืนรายงานข่าวกรองที่สร้างขึ้น
get_intelligence_reports_by_vendor - ดูรายงานข่าวกรองทั้งหมดของผู้ขาย
- vendorDomain: ชื่อโดเมนหลักของผู้ขาย (string, required)
ส่งคืนรายการรายงานข่าวกรองของผู้ขายที่ระบุ
get_intelligence_report - ดูรายงานข่าวกรองตาม ID
- id: ID รายงาน (UUID, required)
update_bitsight_intelligence_report, update_security_scorecard_intelligence_report, update_recorded_future_intelligence_report - แทนที่รายงานข่าวกรองที่มีอยู่
- id: ID รายงาน (UUID, required)
- request: ฟิลด์เดียวกันกับเครื่องมือ
create_*_intelligence_reportที่ตรงกัน ฟิลด์ตัวเลือกที่ไม่ระบุจะถูกล้างค่า
delete_intelligence_report - ลบรายงานข่าวกรองอย่างถาวร
- id: ID รายงาน (UUID, required)
bulk_create_bitsight_intelligence_reports, bulk_create_security_scorecard_intelligence_reports, bulk_create_recorded_future_intelligence_reports - สร้างรายงานข่าวกรองได้สูงสุด 1000 รายการในครั้งเดียว
- reports: ฟิลด์เดียวกันกับเครื่องมือ
create_*_intelligence_reportที่ตรงกัน (object[], required)
ส่งคืน totalCount, ID รายงาน created และ backgroundedCount สำหรับรายงานที่เข้าคิวเพื่อสร้างในเบื้องหลัง
get_latest_intelligence_report - ดูรายงานข่าวกรองล่าสุดของผู้ขายจากแหล่งที่ระบุ
- vendorDomain: ชื่อโดเมนหลักของผู้ขาย (string, required)
- source: ผู้ให้บริการข่าวกรอง (string enum:
BITSIGHT,SECURITY_SCORECARDหรือRECORDED_FUTURE, required)
ส่งคืนรายงานข่าวกรองล่าสุดของผู้ขายและแหล่งที่ระบุ
คำแนะนำความเสี่ยง
get_risk_advisories_by_vendor - ดูคำแนะนำความเสี่ยงทั้งหมดของผู้ขาย
- vendorId: ID ผู้ขาย (number, required)
ส่งคืนคำแนะนำด้านความปลอดภัย การปฏิบัติตามข้อกำหนด ช่องโหว่ กฎหมาย ภูมิรัฐศาสตร์ การเงิน และการดำเนินงานที่เผยแพร่สำหรับผู้ขาย
ผู้ใช้
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 โดยอัตโนมัติเพื่อให้รูปแบบโค้ดสอดคล้องกัน
การตั้งค่า
หลังจากโคลน repository แล้ว pre-commit hook จะได้รับการตั้งค่าโดยอัตโนมัติเมื่อคุณเรียกใช้คำสั่ง Gradle ใดๆ
การจัดรูปแบบด้วยตนเอง
หากต้องการจัดรูปแบบไฟล์ทั้งหมดด้วยตนเอง:
./gradlew spotlessApply
หากต้องการตรวจสอบว่าไฟล์จัดรูปแบบถูกต้องหรือไม่:
./gradlew spotlessCheck
หาก pre-commit hook ปฏิเสธ commit ของคุณเนื่องจากปัญหาการจัดรูปแบบ ให้เรียกใช้ ./gradlew spotlessApply เพื่อแก้ไขการจัดรูปแบบ แล้วลอง commit อีกครั้ง
ใบอนุญาต
โปรเจกต์นี้เผยแพร่ภายใต้ MIT License ดูรายละเอียดได้ในไฟล์ LICENSE