VISO TRUST

VISO TRUST MCP सर्वर

एक मॉडल कॉन्टेक्स्ट प्रोटोकॉल (MCP) सर्वर जो VISO TRUST API क्षमताओं को AI सहायकों के साथ एकीकृत करता है।

होस्टेड रिमोट सर्वर

VISO TRUST इस MCP सर्वर का एक प्रबंधित इंस्टेंस होस्ट करता है, इसलिए आपको आरंभ करने के लिए कुछ भी बनाने, चलाने या स्वयं-होस्ट करने की आवश्यकता नहीं है:

https://mcp.visotrust.com/mcp

स्ट्रीमेबल 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 इंस्पेक्टर के साथ होस्टेड एंडपॉइंट का परीक्षण करने के लिए, npx @modelcontextprotocol/inspector चलाएँ, ट्रांसपोर्ट प्रकार को स्ट्रीमेबल HTTP पर सेट करें, और ऊपर दिए गए URL का उपयोग करें।

इस दस्तावेज़ का शेष भाग सर्वर को स्वयं चलाने (स्थानीय रूप से या अपने स्वयं के बुनियादी ढांचे में) को कवर करता है।

आवश्यकताएँ

• Java 21+
• Gradle
• Docker (कंटेनरीकृत परिनियोजन के लिए वैकल्पिक)
• MCP इंस्पेक्टर (परीक्षण के लिए वैकल्पिक)

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

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

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

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

नोट: क्लाइंट एकल स्ट्रीमेबल 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 के बजाय स्ट्रीमेबल HTTP के माध्यम से जुड़ेंगे
• जब आपको वितरित परिनियोजनों के लिए उन्नत लॉगिंग और निगरानी की आवश्यकता हो
• जब स्ट्रीमेबल HTTP पर जुड़ने वाले वेब-आधारित AI सहायकों के साथ एकीकृत किया जा रहा हो

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

इंस्टॉलेशन

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

VS Code में VISO MCP सर्वर स्थापित करने के लिए नीचे दिए गए बटनों में से एक पर क्लिक करें:

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

VS Code में अपनी उपयोगकर्ता सेटिंग्स (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 इंस्पेक्टर स्थापित करें

npm -g install @modelcontextprotocol/inspector

परीक्षण के लिए MCP इंस्पेक्टर चलाएँ

1. MCP सर्वर Jar फ़ाइल बनाएँ

./gradlew bootJar

2. MCP इंस्पेक्टर चलाएँ

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 सर्वर द्वारा उजागर किए गए उपकरणों के लिए दस्तावेज़ीकरण प्रदान करता है। प्रत्येक उपकरण का एक विशिष्ट उद्देश्य, इनपुट पैरामीटर और आउटपुट प्रारूप होता है।

आकलन

get_assessment - किसी आकलन को उसकी ID द्वारा प्राप्त करें

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

किसी विशिष्ट आकलन के बारे में विस्तृत जानकारी लौटाता है।

get_assessment_summary - किसी आकलन का सारांश उसकी ID द्वारा प्राप्त करें

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

किसी विशिष्ट आकलन के लिए सारांश विवरण लौटाता है।

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_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: इस संबंध के लिए व्यावसायिक संदर्भ प्रकारों की सूची (ऑब्जेक्ट[], वैकल्पिक)
• dataTypes: इस संबंध में नियंत्रित डेटा प्रकारों की सूची (ऑब्जेक्ट[], वैकल्पिक)
• tags: इस संबंध को वर्गीकृत करने के लिए टैग की सूची (स्ट्रिंग[], वैकल्पिक)
• thirdPartyContact: तृतीय-पक्ष विक्रेता प्रतिनिधि का संपर्क विवरण (ऑब्जेक्ट, वैकल्पिक)

निर्मित संबंध विवरण लौटाता है।

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

• domain: विक्रेता का डोमेन, जैसे visotrust.com (स्ट्रिंग, आवश्यक)
• vendorName: विक्रेता का नाम (स्ट्रिंग, आवश्यक)
• product: विक्रेता द्वारा प्रस्तुत उत्पाद (स्ट्रिंग, वैकल्पिक)
• description: विक्रेता संबंध का विवरण (स्ट्रिंग, वैकल्पिक)

निर्मित संबंध विवरण लौटाता है।

update_relationship - किसी तृतीय-पक्ष विक्रेता के साथ मौजूदा संबंध अपडेट करें

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

अपडेट किए गए संबंध विवरण लौटाता है।

partially_update_relationship - मौजूदा संबंध को आंशिक रूप से अपडेट करें

update_relationship के समान फ़ील्ड स्वीकार करता है। अनुरोध में प्रदान किए गए फ़ील्ड ही बदले जाते हैं; अन्य फ़ील्ड अछूते रहते हैं।

अपडेट किए गए संबंध विवरण लौटाता है।

search_relationships - डोमेन नाम या विक्रेता नाम से संबंध खोजें

• domains: खोजने के लिए डोमेन नामों की सूची (string[], आवश्यक)
• name: खोजने के लिए विक्रेता/संबंध का नाम (स्ट्रिंग, आवश्यक)

उनके मूल्यांकन विवरण के साथ मेल खाने वाले संबंधों की सूची लौटाता है।

create_tags - संबंधों को वर्गीकृत करने के लिए नए टैग बनाएं

• tags: बनाने के लिए टैग नामों की सूची (string[], आवश्यक)

नए बनाए गए टैग सहित सभी टैग की सूची लौटाता है।

update_third_party_contact - किसी तृतीय-पक्ष विक्रेता के लिए संपर्क विवरण अपडेट करें

• relationshipId: संबंध आईडी (संख्या, आवश्यक)
• email: संपर्क ईमेल (स्ट्रिंग, आवश्यक)
• firstName: संपर्क का पहला नाम (स्ट्रिंग, आवश्यक)
• lastName: संपर्क का अंतिम नाम (स्ट्रिंग, आवश्यक)

अपडेट किए गए संबंध विवरण लौटाता है।

onboard_relationship - किसी संबंध को ऑनबोर्ड करें, वैकल्पिक रूप से अनुमोदन सारांश और जीवनचक्र प्रबंधन सेटिंग्स के साथ

• id: संबंध आईडी (संख्या, आवश्यक)
• approvalSummary: ऑनबोर्डिंग पर दर्ज वैकल्पिक अनुमोदन सारांश (स्ट्रिंग, वैकल्पिक)
• lifecycleManagementUpdateRequest: वैकल्पिक जीवनचक्र प्रबंधन सेटिंग्स (object, वैकल्पिक)
  • artifactUpdateSettings.artifactUpdateType: आर्टिफैक्ट अपडेट प्रकार (स्ट्रिंग एनम)
  • recertificationSettings.recertificationType: पुनर्प्रमाणन प्रकार (स्ट्रिंग एनम)
  • recertificationSettings.recertificationDate: अगले पुनर्प्रमाणन की तिथि/समय, ऑफसेट के साथ ISO-8601 (स्ट्रिंग)
  • recertificationSettings.reviewFrequency: THREE_YEARS, TWO_YEARS, ANNUAL, SEMIANNUAL, या QUARTERLY (स्ट्रिंग एनम)

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

offboard_relationship - किसी संबंध को ऑफबोर्ड करें

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

ऑफबोर्ड किए गए संबंध विवरण लौटाता है।

archive_relationship - किसी संबंध को संग्रहित करें

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

संग्रहीत संबंध विवरण लौटाता है।

वेबहुक

get_all_webhooks - सभी वेबहुक प्राप्त करें

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

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

get_webhook - आईडी द्वारा वेबहुक कॉन्फ़िगरेशन प्राप्त करें

• id: वेबहुक आईडी (संख्या, आवश्यक)

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

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

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

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

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

• request: वेबहुक अपडेट पैरामीटर (object, आवश्यक)
  • id: वेबहुक आईडी (संख्या, आवश्यक)
  • url: वेबहुक URL (स्ट्रिंग, वैकल्पिक)
  • secret: वेबहुक सीक्रेट (स्ट्रिंग, वैकल्पिक)
  • eventTypes: वेबहुक को ट्रिगर करने वाली घटनाओं के प्रकार (string[], वैकल्पिक)
  • serviceType: वेबहुक के लिए सेवा का प्रकार (स्ट्रिंग, वैकल्पिक)

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

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

• id: वेबहुक आईडी (संख्या, आवश्यक)

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

इंटेलिजेंस रिपोर्ट

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

• request: BitSight रिपोर्ट पैरामीटर (object, आवश्यक)
  • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (स्ट्रिंग, आवश्यक)
  • reportDate: रिपोर्ट तैयार होने की तिथि/समय (ISO 8601 स्ट्रिंग, आवश्यक)
  • link: प्रदाता के UI का वैकल्पिक लिंक (स्ट्रिंग, वैकल्पिक)
  • guid: इकाई के लिए BitSight GUID (स्ट्रिंग, आवश्यक)
  • customId: BitSight से कस्टम पहचानकर्ता (स्ट्रिंग, वैकल्पिक)
  • name: BitSight इकाई का प्रदर्शन नाम (स्ट्रिंग, वैकल्पिक)
  • description: BitSight इकाई का विवरण (स्ट्रिंग, वैकल्पिक)
  • primaryDomain: BitSight इकाई के लिए प्राथमिक डोमेन (स्ट्रिंग, वैकल्पिक)
  • ratingRange: BitSight रेटिंग सीमा (स्ट्रिंग, वैकल्पिक)
  • ratingColor: BitSight रेटिंग रंग (स्ट्रिंग, वैकल्पिक)
  • confidence: BitSight रेटिंग का विश्वास स्तर (स्ट्रिंग, वैकल्पिक)

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

create_security_scorecard_intelligence_report - एक नई SecurityScorecard इंटेलिजेंस रिपोर्ट बनाएं

• request: SecurityScorecard रिपोर्ट पैरामीटर (object, आवश्यक)
  • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (स्ट्रिंग, आवश्यक)
  • reportDate: रिपोर्ट तैयार होने की तिथि/समय (ISO 8601 स्ट्रिंग, आवश्यक)
  • link: प्रदाता के UI का वैकल्पिक लिंक (स्ट्रिंग, वैकल्पिक)
  • grade: SecurityScorecard अक्षर ग्रेड (स्ट्रिंग, आवश्यक)
  • domain: स्कोरकार्ड इकाई से संबद्ध डोमेन (स्ट्रिंग, वैकल्पिक)
  • score: SecurityScorecard से संख्यात्मक स्कोर (संख्या, वैकल्पिक)

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

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

• request: Recorded Future रिपोर्ट पैरामीटर (object, आवश्यक)
  • vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (स्ट्रिंग, आवश्यक)
  • reportDate: रिपोर्ट तैयार होने की तिथि/समय (ISO 8601 स्ट्रिंग, आवश्यक)
  • entityType: Recorded Future इकाई प्रकार, जैसे Company (स्ट्रिंग, आवश्यक)
  • entity: Recorded Future इकाई पहचानकर्ता (स्ट्रिंग, आवश्यक)
  • riskScore: संख्यात्मक जोखिम स्कोर (संख्या, आवश्यक)
  • riskLevel: जोखिम स्तर लेबल, जैसे Critical/High/Medium/Low (स्ट्रिंग, आवश्यक)
  • link: प्रदाता के UI में रिपोर्ट का वैकल्पिक लिंक (स्ट्रिंग, वैकल्पिक)
  • firstSeen: इकाई के लिए सबसे पहली देखी गई तिथि, ISO 8601 (स्ट्रिंग, वैकल्पिक)
  • lastSeen: इकाई के लिए सबसे हाल की देखी गई तिथि, ISO 8601 (स्ट्रिंग, वैकल्पिक)
  • triggeredRuleCount: ट्रिगर हुए Recorded Future नियमों की संख्या (संख्या, वैकल्पिक)
  • maxRuleCount: मूल्यांकित Recorded Future नियमों की अधिकतम संख्या (संख्या, वैकल्पिक)
  • summary: Recorded Future से वैकल्पिक सारांश पाठ (स्ट्रिंग, वैकल्पिक)
  • criticalityLabel: इकाई के लिए Recorded Future गंभीरता लेबल (स्ट्रिंग, वैकल्पिक)

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

get_intelligence_reports_by_vendor - किसी विक्रेता के लिए सभी इंटेलिजेंस रिपोर्ट प्राप्त करें

• vendorDomain: विक्रेता का प्राथमिक डोमेन नाम (स्ट्रिंग, आवश्यक)

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

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

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

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

उपयोगकर्ता

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

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

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

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

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

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

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

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

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

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

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

सेटअप

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

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

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

./gradlew spotlessApply

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

./gradlew spotlessCheck

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

लाइसेंस

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