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

इस एंडपॉइंट से जुड़ने के लिए किसी भी MCP क्लाइंट को Streamable HTTP ट्रांसपोर्ट का उपयोग करके कनेक्ट करें और अपने 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 प्रोफ़ाइल Streamable HTTP ट्रांसपोर्ट पर रिमोट MCP समर्थन के लिए बनाई गई है। यह प्रोफ़ाइल सर्वर को वेब एप्लिकेशन के रूप में चलाती है, ताकि वह HTTP पर रिमोट क्लाइंट से संचार कर सके। (Streamable HTTP, अप्रचलित SSE ट्रांसपोर्ट का स्थान लेता है; यहाँ इसे स्टेटलेस मोड में कॉन्फ़िगर किया गया है।)

रिमोट प्रोफ़ाइल के मुख्य अंतर:

  • मानक I/O के बजाय पोर्ट 3001 पर servlet वेब एप्लिकेशन (Tomcat) के रूप में चलता है
  • MCP एंडपॉइंट POST /mcp (Streamable HTTP) पर उपलब्ध कराता है
  • स्टेटलेस मोड में चलता है — प्रति-सत्र सर्वर स्थिति नहीं होती, इसलिए सत्र-आधारित स्टिकीनेस की आवश्यकता के बिना लोड बैलेंसर के पीछे क्षैतिज रूप से स्केल किया जा सकता है
  • रिमोट क्लाइंट कनेक्शन के लिए अनुकूलित सर्वर सेटिंग्स
  • वितरित डिबगिंग के लिए बेहतर लॉगिंग

ध्यान दें: क्लाइंट एकल Streamable HTTP एंडपॉइंट …/mcp से कनेक्ट होते हैं। पुराने SSE एंडपॉइंट (/sse + /mcp/message) अब उपलब्ध नहीं हैं।

रिमोट प्रोफ़ाइल सक्रिय करने का तरीका:

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

रिमोट प्रोफ़ाइल का उपयोग कब करें:

  • MCP सर्वर को रिमोट सर्वर या क्लाउड परिवेश में डिप्लॉय करते समय
  • जब क्लाइंट सीधे stdio के बजाय Streamable HTTP के माध्यम से कनेक्ट हों
  • वितरित डिप्लॉयमेंट के लिए बेहतर लॉगिंग और मॉनिटरिंग की आवश्यकता होने पर
  • Streamable HTTP पर कनेक्ट होने वाले वेब-आधारित AI सहायकों के साथ एकीकरण करते समय

स्थानीय विकास और सीधे stdio संचार के लिए, डिफ़ॉल्ट प्रोफ़ाइल का उपयोग करें (किसी प्रोफ़ाइल का नाम निर्दिष्ट करने की आवश्यकता नहीं है)।

इंस्टॉलेशन

त्वरित इंस्टॉल

VS Code में VISO MCP Server इंस्टॉल करने के लिए नीचे दिए गए बटनों में से किसी एक पर क्लिक करें:

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

VS Code के साथ मैन्युअल सेटअप

VS Code में अपनी User Settings (JSON) फ़ाइल में निम्नलिखित 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}"
        }
      }
    }
  }
}

वैकल्पिक रूप से, आप अपने वर्कस्पेस में .vscode/mcp.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}"
      }
    }
  }
}

Claude Desktop और अन्य MCP क्लाइंट के साथ उपयोग

Docker कॉन्फ़िगरेशन

{
    "mcpServers": {
        "viso-mcp": {
            "command": "docker",
            "args": [
                "run",
                "-i",
                "--rm",
                "-e", "VISOTRUST_API_TOKEN",
                "-e", "VISOTRUST_API_BASEURL",
                "visotrustai/viso-mcp-server:latest"
            ],
            "env": {
                "VISOTRUST_API_TOKEN": "<your-api-token>",
                "VISOTRUST_API_BASEURL": "https://app.visotrust.com"
            }
        }
    }
}

Java कॉन्फ़िगरेशन

{
    "mcpServers": {
        "viso-mcp": {
            "command": "java",
            "args": [
                "-jar",
                "viso-mcp-server-<version>.jar",
                "--port",
                "8080",
                "--host",
                "localhost"
            ],
            "env": {
                "JAVA_TOOL_OPTIONS": "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:5005",
                "VISOTRUST_API_TOKEN": "<your-api-token>",
                "VISOTRUST_API_BASEURL": "https://app.visotrust.com"
            }
        }
    }
}

ध्यान दें: JAVA_TOOL_OPTIONS एनवायरनमेंट वेरिएबल का उपयोग रिमोट डिबगिंग के लिए JVM विकल्प सेट करने हेतु किया जाता है। आवश्यकता के अनुसार पता और पोर्ट बदले जा सकते हैं।

💻 विकास

Docker सेटअप

Docker इमेज बनाएँ

docker build -t viso-mcp-server .

Docker कंटेनर चलाएँ

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

डिबगिंग

MCP Inspector इंस्टॉल करें

npm -g install @modelcontextprotocol/inspector

परीक्षण के लिए MCP Inspector चलाएँ

  1. MCP Server Jar File बनाएँ
./gradlew bootJar
  1. MCP Inspector चलाएँ
npx @modelcontextprotocol/inspector \
    -e JAVA_TOOL_OPTIONS=-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=\*:5005 \
    -e VISOTRUST_API_TOKEN=<your-api-token> \
    java -jar build/libs/viso-mcp-server-<version>.jar \
    --port 8080 --host localhost

<version> को प्रोजेक्ट के वर्तमान संस्करण से बदलें (उदाहरण के लिए, 1.0.0 या नवीनतम रिलीज़ का संस्करण)।

CI/CD पाइपलाइन

यह प्रोजेक्ट निरंतर एकीकरण और डिप्लॉयमेंट के लिए GitHub Actions का उपयोग करता है। वर्कफ़्लो में निम्नलिखित जॉब शामिल हैं:

लिंट

Spotless का उपयोग करके कोड फ़ॉर्मैटिंग की जाँच करता है:

./gradlew spotlessCheck

बिल्ड

एप्लिकेशन बनाता है और JAR फ़ाइल तैयार करता है:

./gradlew build

प्रकाशित करें

नई रिलीज़ बनाए जाने पर:

  1. build.gradle में प्रोजेक्ट संस्करण को रिलीज़ टैग से मेल खाने के लिए अपडेट करता है
  2. रिलीज़ टैग के संस्करण के साथ JAR फ़ाइल को GitHub रिलीज़ पर अपलोड करता है
  3. निम्नलिखित टैग के साथ 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: फ़ॉलो-अप का प्रकार (स्ट्रिंग enum, वैकल्पिक)
  • followupRiskThreshold: फ़ॉलो-अप शुरू करने वाला जोखिम स्तर (स्ट्रिंग enum, वैकल्पिक)
  • followupTimeline: फ़ॉलो-अप कार्रवाइयों की समय-सीमा (स्ट्रिंग enum, वैकल्पिक)
  • collectionTimeline: विक्रेता द्वारा आकलन सबमिशन पूरा करने की समय-सीमा (स्ट्रिंग enum, वैकल्पिक)
  • noVendorResponseAction: विक्रेता के जवाब न देने पर की जाने वाली कार्रवाई (स्ट्रिंग enum, वैकल्पिक)
  • aiProcessingOnly: क्या मानव समीक्षा के बिना केवल AI से प्रोसेस करना है (बूलियन, वैकल्पिक)
  • requestedAuditTypes: इस आकलन के लिए अनुरोधित ऑडिट के प्रकार (स्ट्रिंग[], वैकल्पिक)

बनाए गए आकलन का विवरण लौटाता है।

update_assessment_expiration_date - विक्रेता द्वारा आकलन का जवाब जमा करने की समय-सीमा अपडेट करें

  • id: आकलन ID (संख्या, आवश्यक)
  • expirationDate: नई समाप्ति तिथि/समय, ऑफ़सेट सहित ISO-8601; भविष्य का होना आवश्यक है (स्ट्रिंग, आवश्यक)

पुष्टिकरण संदेश लौटाता है।

update_assessment_followup - आकलन के लिए फ़ॉलो-अप कॉन्फ़िगरेशन अपडेट करें

  • id: आकलन ID (संख्या, आवश्यक)
  • followupType: फ़ॉलो-अप का प्रकार (स्ट्रिंग enum, आवश्यक)
  • followupRiskThreshold: वह जोखिम सीमा या उससे अधिक, जिस पर फ़ॉलो-अप आकलन शुरू किया जाना चाहिए (स्ट्रिंग enum, वैकल्पिक)
  • followupTimeline: फ़ॉलो-अप की समय-सीमा (स्ट्रिंग enum, वैकल्पिक)

पुष्टिकरण संदेश लौटाता है।

ऑडिट लॉग

get_user_audit_log_events - अपने संगठन के उपयोगकर्ता-सीमित ऑडिट लॉग इवेंट प्राप्त करें

  • start: क्वेरी की आरंभ तिथि/समय, ऑफ़सेट सहित ISO-8601 (स्ट्रिंग, आवश्यक)
  • end: क्वेरी की समाप्ति तिथि/समय, ऑफ़सेट सहित ISO-8601 (स्ट्रिंग, आवश्यक)
  • eventTypes: फ़िल्टर करने के लिए इवेंट प्रकारों का वैकल्पिक सेट (उदाहरण के लिए USER_LOGGED_IN); सभी के लिए खाली छोड़ें (स्ट्रिंग[], वैकल्पिक)

अधिकतम 500 रिकॉर्ड तक सीमित, उपयोगकर्ता ऑडिट लॉग इवेंट की सूची लौटाता है।

get_audit_log_events - फ़िल्टर किए गए ऑडिट लॉग इवेंट प्राप्त करें (उपयोगकर्ता, संगठन, आकलन और संबंध इवेंट)

  • start: क्वेरी की आरंभ तिथि/समय, ऑफ़सेट सहित ISO-8601 (स्ट्रिंग, आवश्यक)
  • end: क्वेरी की समाप्ति तिथि/समय, ऑफ़सेट सहित ISO-8601 (स्ट्रिंग, आवश्यक)
  • eventTypes: फ़िल्टर करने के लिए इवेंट प्रकारों का वैकल्पिक सेट (उदाहरण के लिए ASSESSMENT_COMPLETED, RELATIONSHIP_CREATED); सभी के लिए खाली छोड़ें (स्ट्रिंग[], वैकल्पिक)

पॉलीमॉर्फ़िक ऑडिट लॉग इवेंट रिकॉर्ड लौटाता है। हर आइटम में कम-से-कम auditEventType और dateTime होते हैं।

व्यावसायिक इकाइयाँ

get_all_business_units - अपने संगठन की सभी व्यावसायिक इकाइयाँ नाम के अनुसार क्रमबद्ध करके प्राप्त करें

हर व्यावसायिक इकाई का id (जिसे search_relationships में businessUnitIds फ़िल्टर के रूप में उपयोग किया जा सकता है) और name (जिसे create_user में businessUnit के रूप में उपयोग किया जा सकता है) लौटाता है।

व्यावसायिक मामले

get_all_business_cases - अपने संगठन के सभी उपलब्ध व्यावसायिक मामले प्राप्त करें

कोई पैरामीटर आवश्यक नहीं।

आपके संगठन के लिए उपलब्ध सभी व्यावसायिक मामलों की सूची लौटाता है।

डेटा प्रकार

get_all_datatypes - अपने संगठन के सभी उपलब्ध डेटा प्रकार प्राप्त करें

कोई पैरामीटर आवश्यक नहीं।

आपके संगठन के लिए उपलब्ध सभी डेटा प्रकारों की सूची लौटाता है।

विक्रेता निर्देशिका

search_vendor_directory - URL या डोमेन के आधार पर VISO TRUST विक्रेता निर्देशिका में विक्रेता खोजें

  • urlOrDomain: खोजने के लिए URL या डोमेन नाम, उदाहरण के लिए example.com (स्ट्रिंग, आवश्यक)

विक्रेता का बुनियादी मेटाडेटा (नाम, होमपेज, विवरण, फ़ेविकॉन, ज्ञात डोमेन) लौटाता है।

संबंध

get_all_relationships - सभी संबंधों और उनके आकलन विवरणों की सूची प्राप्त करें

कोई पैरामीटर आवश्यक नहीं।

तृतीय-पक्ष विक्रेताओं की जानकारी लौटाता है, जिसमें उनकी आकलन स्थिति, जोखिम स्तर और संपर्क विवरण शामिल हैं।

get_relationship_by_id - ID के आधार पर किसी विशिष्ट संबंध और उसके आकलन विवरण प्राप्त करें

  • id: संबंध ID (संख्या, आवश्यक)

तृतीय-पक्ष विक्रेता की विस्तृत जानकारी लौटाता है, जिसमें आकलन स्थिति, जोखिम स्तर और संपर्क विवरण शामिल हैं।

get_relationship_assessment_history - किसी संबंध का आकलन इतिहास प्राप्त करें

  • id: संबंध ID (संख्या, आवश्यक)

निर्दिष्ट संबंध से जुड़े आकलनों की सूची लौटाता है।

create_relationship - तृतीय-पक्ष विक्रेता के साथ नया संबंध बनाएँ

  • name: संबंध/विक्रेता का नाम (स्ट्रिंग, आवश्यक)
  • homepage: विक्रेता के होमपेज का URL (स्ट्रिंग, आवश्यक)
  • businessOwnerEmail: व्यवसाय स्वामी का ईमेल पता (स्ट्रिंग, आवश्यक)
  • businessOwnerFirstName: व्यवसाय स्वामी का पहला नाम (स्ट्रिंग, वैकल्पिक)
  • businessOwnerLastName: व्यवसाय स्वामी का उपनाम (स्ट्रिंग, वैकल्पिक)
  • description: संबंध/विक्रेता का विवरण (स्ट्रिंग, वैकल्पिक)
  • contextTypes: इस संबंध के लिए व्यावसायिक संदर्भ प्रकारों की सूची (object[], वैकल्पिक)
  • dataTypes: इस संबंध में संभाले जाने वाले डेटा प्रकारों की सूची (object[], वैकल्पिक)
  • tags: इस संबंध को वर्गीकृत करने के लिए टैग की सूची (स्ट्रिंग[], वैकल्पिक)
  • thirdPartyContact: तृतीय-पक्ष विक्रेता के प्रतिनिधि का संपर्क विवरण (object, वैकल्पिक)

बनाए गए संबंध का विवरण लौटाता है।

create_relationship_by_domain - केवल विक्रेता डोमेन का उपयोग करके नया संबंध बनाएँ

  • domain: विक्रेता का डोमेन, जैसे visotrust.com (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: सटीक बाहरी 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: get_all_business_units से व्यावसायिक इकाई IDs (number[], optional)
    • businessOwnerIds / creatorIds: get_all_users से उपयोगकर्ता IDs (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 (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 - सभी वेबहुक प्राप्त करें

किसी पैरामीटर की आवश्यकता नहीं है।

सभी वेबहुक कॉन्फ़िगरेशन की सूची लौटाता है।

get_webhook - ID के आधार पर वेबहुक कॉन्फ़िगरेशन प्राप्त करें

  • id: वेबहुक ID (number, required)

किसी विशिष्ट वेबहुक कॉन्फ़िगरेशन का विवरण लौटाता है।

create_webhook_configuration - वेबहुक कॉन्फ़िगरेशन बनाएँ

  • request: वेबहुक बनाने के पैरामीटर (object, required)
    • url: वेबहुक URL (string, required)
    • secret: वेबहुक सीक्रेट (string, required)
    • eventTypes: वेबहुक ट्रिगर करने वाले इवेंट के प्रकार (string[], required)
    • serviceType: वेबहुक के लिए सेवा का प्रकार (string, required)

बनाया गया वेबहुक कॉन्फ़िगरेशन लौटाता है।

update_webhook_configuration - वेबहुक कॉन्फ़िगरेशन अपडेट करें

  • request: वेबहुक अपडेट करने के पैरामीटर (object, required)
    • id: वेबहुक ID (number, required)
    • url: वेबहुक URL (string, optional)
    • secret: वेबहुक सीक्रेट (string, optional)
    • eventTypes: वेबहुक ट्रिगर करने वाले इवेंट के प्रकार (string[], optional)
    • serviceType: वेबहुक के लिए सेवा का प्रकार (string, optional)

अपडेट किया गया वेबहुक कॉन्फ़िगरेशन लौटाता है।

delete_webhook_configuration - वेबहुक कॉन्फ़िगरेशन हटाएँ

  • id: वेबहुक ID (number, required)

निर्दिष्ट वेबहुक कॉन्फ़िगरेशन हटाता है।

Intelligence Reports

create_bitsight_intelligence_report - नई BitSight इंटेलिजेंस रिपोर्ट बनाएँ

  • request: BitSight रिपोर्ट के पैरामीटर (object, required)
    • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (string, required)
    • reportDate: रिपोर्ट जनरेट किए जाने की दिनांक/समय (ISO 8601 string, required)
    • link: प्रदाता के UI का वैकल्पिक लिंक (string, optional)
    • guid: इकाई के लिए BitSight GUID (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 string, required)
    • link: प्रदाता के UI का वैकल्पिक लिंक (string, optional)
    • grade: SecurityScorecard का अक्षरीय ग्रेड (string, required)
    • domain: स्कोरकार्ड इकाई से संबद्ध डोमेन (string, optional)
    • score: SecurityScorecard का संख्यात्मक स्कोर (number, optional)

बनाई गई इंटेलिजेंस रिपोर्ट लौटाता है।

create_recorded_future_intelligence_report - नई Recorded Future इंटेलिजेंस रिपोर्ट बनाएँ

  • request: Recorded Future रिपोर्ट के पैरामीटर (object, required)
    • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (string, required)
    • reportDate: रिपोर्ट जनरेट किए जाने की दिनांक/समय (ISO 8601 string, 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, रिपोर्ट IDs created, और पृष्ठभूमि में बनाए जाने के लिए कतारबद्ध रिपोर्टों हेतु backgroundedCount लौटाता है।

get_latest_intelligence_report - किसी विशिष्ट स्रोत से विक्रेता की नवीनतम इंटेलिजेंस रिपोर्ट प्राप्त करें

  • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (string, required)
  • source: इंटेलिजेंस प्रदाता (string enum: BITSIGHT, SECURITY_SCORECARD, या RECORDED_FUTURE, required)

निर्दिष्ट विक्रेता और स्रोत की नवीनतम इंटेलिजेंस रिपोर्ट लौटाता है।

Risk Advisories

get_risk_advisories_by_vendor - किसी विक्रेता के सभी जोखिम परामर्श प्राप्त करें

  • vendorId: विक्रेता ID (number, required)

विक्रेता के लिए प्रकाशित सुरक्षा, अनुपालन, भेद्यता, कानूनी, भू-राजनीतिक, वित्तीय और परिचालन संबंधी परामर्श लौटाता है।

Users

get_all_users - अपने संगठन के सभी उपयोगकर्ता प्राप्त करें

  • page: प्राप्त करने के लिए परिणाम पृष्ठ (संख्या, वैकल्पिक; डिफ़ॉल्ट 0)
  • size: प्रति पृष्ठ रिकॉर्ड की संख्या (संख्या, वैकल्पिक; डिफ़ॉल्ट 20)
  • sort: इस प्रारूप में क्रमबद्ध करने के मानदंड: property(,asc|desc) (स्ट्रिंग, वैकल्पिक)

उपयोगकर्ताओं की पृष्ठांकित सूची लौटाता है।

get_user_by_email - ईमेल से उपयोगकर्ता प्राप्त करें

  • email: उपयोगकर्ता का ईमेल पता (स्ट्रिंग, आवश्यक)

उपयोगकर्ता का विवरण लौटाता है।

create_user - नया उपयोगकर्ता बनाएँ

  • request: उपयोगकर्ता बनाने के पैरामीटर (ऑब्जेक्ट, आवश्यक)
    • email: नए उपयोगकर्ता का ईमेल पता (स्ट्रिंग, आवश्यक)
    • firstName: नए उपयोगकर्ता का पहला नाम (स्ट्रिंग, आवश्यक)
    • lastName: नए उपयोगकर्ता का अंतिम नाम (स्ट्रिंग, आवश्यक)

बनाया गया उपयोगकर्ता लौटाता है।

कोड फ़ॉर्मैटिंग

यह प्रोजेक्ट कोड फ़ॉर्मैटिंग के लिए Google Java Format के साथ Spotless का उपयोग करता है। कोड शैली में एकरूपता सुनिश्चित करने के लिए प्री-कमिट हुक अपने आप सेट अप हो जाता है।

सेटअप

रिपॉज़िटरी क्लोन करने के बाद, कोई भी Gradle कमांड चलाने पर प्री-कमिट हुक अपने आप सेट अप हो जाएगा।

मैन्युअल फ़ॉर्मैटिंग

सभी फ़ाइलों को मैन्युअल रूप से फ़ॉर्मैट करने के लिए:

./gradlew spotlessApply

यह जाँचने के लिए कि फ़ाइलें सही ढंग से फ़ॉर्मैट की गई हैं या नहीं:

./gradlew spotlessCheck

यदि फ़ॉर्मैटिंग संबंधी समस्याओं के कारण प्री-कमिट हुक आपका कमिट अस्वीकार कर देता है, तो फ़ॉर्मैटिंग ठीक करने के लिए बस ./gradlew spotlessApply चलाएँ और फिर दोबारा कमिट करने का प्रयास करें।

लाइसेंस

यह प्रोजेक्ट MIT License के अंतर्गत लाइसेंस प्राप्त है - विवरण के लिए LICENSE फ़ाइल देखें।