खोज केवल इस्तेमाल करने पर लोड होती है। नीचे सभी श्रेणियाँ देखें।

प्रमाणीकरण की शुरुआती प्रक्रिया

एजेंट प्रमाणीकरण: config

निश्चित लूपबैक कॉलबैक सहित एजेंट साइन-इन कॉन्फ़िगरेशन पढ़ें। साइन-इन के लिए समर्थित CLI या रिमोट OAuth क्लाइंट इस्तेमाल करें; यह एंडपॉइंट प्रोटोकॉल का दस्तावेज़ है।

POST /identity-api/agent-auth/config

कॉन्ट्रैक्ट की समीक्षा: · sha256:563d2d581da0ad29

परिचय

निश्चित लूपबैक कॉलबैक सहित एजेंट साइन-इन कॉन्फ़िगरेशन पढ़ें। साइन-इन के लिए समर्थित CLI या रिमोट OAuth क्लाइंट इस्तेमाल करें; यह एंडपॉइंट प्रोटोकॉल का दस्तावेज़ है।

सफल HTTP रिस्पॉन्स का अर्थ अनुरोध पूरा होने के बजाय स्वीकार होना हो सकता है। बैकग्राउंड काम में लौटाई ID सहेजें और समाप्ति तक वही ऑपरेशन जाँचें। निर्धारित या स्वीकृत पोस्ट प्लेटफ़ॉर्म की पुष्टि पर ही प्रकाशित है; क्लाइंट टाइमआउट परिणाम सिद्ध नहीं करता।

यह एंडपॉइंट साइन-इन प्रोटोकॉल का है और api post से उपलब्ध नहीं है। समर्थित ब्राउज़र साइन-इन अपनाएँ और सेशन क्रेडेंशियल आउटपुट व लॉग से बाहर रखें।

प्रमाणीकरण और अनुमतियाँ

स्वीकार्य क्रेडेंशियल श्रेणियाँ
anonymous
प्रत्यायोजित क्षमता
oauth-bootstrap
न्यूनतम वर्कस्पेस भूमिका
इस कॉन्ट्रैक्ट में न्यूनतम वर्कस्पेस भूमिका नहीं है; स्वामित्व और प्राधिकरण की जाँच फिर भी लागू है।
एक्सेस का दायरा
वे संसाधन जिनके एक्सेस के लिए यह यूज़र अधिकृत है
सभी वर्कस्पेस के लिए सहमति आवश्यक
नहीं
स्थिति बदलता है
नहीं
ऑपरेशन पूरा होने पर
not_agent_callable

टोकन केवल मालिक के अधिकार इस्तेमाल कर सकता है। हर अनुरोध वर्कस्पेस सदस्यता, संसाधन स्वामित्व, चुने वर्कस्पेस और दी क्षमताएँ जाँचता है। Core और full प्रोफ़ाइल दिखने वाले टूल बदलते हैं; एक्सेस नहीं देते।

अनुरोध के फ़ील्ड

Required का अर्थ पैरेंट ऑब्जेक्ट और चुनी शाखा के भीतर अनिवार्य है। अनिवार्य चाइल्ड से वैकल्पिक पैरेंट अनिवार्य नहीं होता। नीचे के नियम और फ़ील्ड नाम कॉन्ट्रैक्ट से लिए गए हैं।

अनुरोध के फ़ील्ड
फ़ील्ड / शाखाप्रकार / अनिवार्यशर्तें
$objectपैरेंट में अनिवार्य
  • additionalProperties: false
संपूर्ण JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {},
  "additionalProperties": false
}

रिस्पॉन्स और पूर्णता

सफल HTTP स्टेटस: 200. When the operation is complete: not_agent_callable.

सफल HTTP रिस्पॉन्स का अर्थ अनुरोध पूरा होने के बजाय स्वीकार होना हो सकता है। बैकग्राउंड काम में लौटाई ID सहेजें और समाप्ति तक वही ऑपरेशन जाँचें। निर्धारित या स्वीकृत पोस्ट प्लेटफ़ॉर्म की पुष्टि पर ही प्रकाशित है; क्लाइंट टाइमआउट परिणाम सिद्ध नहीं करता।

Required का अर्थ पैरेंट ऑब्जेक्ट और चुनी शाखा के भीतर अनिवार्य है। अनिवार्य चाइल्ड से वैकल्पिक पैरेंट अनिवार्य नहीं होता। नीचे के नियम और फ़ील्ड नाम कॉन्ट्रैक्ट से लिए गए हैं।

रिस्पॉन्स और पूर्णता
फ़ील्ड / शाखाप्रकार / अनिवार्यशर्तें
$objectपैरेंट में अनिवार्य—
client_idstringपैरेंट में अनिवार्य
  • minLength: 1
client_namestringपैरेंट में अनिवार्य
  • minLength: 1
redirect_uristringपैरेंट में अनिवार्य
  • const: "http://127.0.0.1:8789/oauth/callback"
authorization_endpointstringपैरेंट में अनिवार्य
  • format: "uri"
token_endpointstringपैरेंट में अनिवार्य
  • format: "uri"
scopesstringपैरेंट में अनिवार्य
  • minLength: 1
संपूर्ण JSON Schema
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "client_id": {
      "type": "string",
      "minLength": 1
    },
    "client_name": {
      "type": "string",
      "minLength": 1
    },
    "redirect_uri": {
      "type": "string",
      "const": "http://127.0.0.1:8789/oauth/callback"
    },
    "authorization_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "token_endpoint": {
      "type": "string",
      "format": "uri"
    },
    "scopes": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "client_id",
    "client_name",
    "redirect_uri",
    "authorization_endpoint",
    "token_endpoint",
    "scopes"
  ]
}

त्रुटियाँ और सुरक्षित पुनः प्रयास

HTTP स्टेटस और रिस्पॉन्स बॉडी जाँचें। 400 वैलिडेशन त्रुटि में ZodError हो सकता है; हैंडलर त्रुटियाँ error, message और code फ़ील्ड इस्तेमाल करती हैं। जाँच के लिए request_id या x-request-id रखें, क्रेडेंशियल के बिना। फिर प्रयास से पहले 401/403 एक्सेस त्रुटियाँ ठीक करें और 429 के लिए Retry-After का पालन करें। राइट अनिश्चित हो या 5xx लौटाए, तो पहले मौजूदा परिणाम पढ़ें। idempotency key केवल समर्थित स्थान पर दोबारा इस्तेमाल करें; पुनः प्रयास का व्यवहार ऑपरेशन के अनुसार बदलता है और ठीक एक बार डिलीवरी की गारंटी नहीं देता।

समस्या निवारण गाइड

उदाहरण

उदाहरणों में स्कीमा से जाँचे काल्पनिक मान हैं। IDs को अधिकृत IDs, मीडिया को तैयार एसेट और तारीखों को पुष्ट प्रकाशन समय से बदलें। राइट सबमिट करने से पहले खाते की पात्रता जाँचें। यह पेज API अनुरोध नहीं भेजता।

request.json

{}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/config" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/config", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify({})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

कृत्रिम रिस्पॉन्स का उदाहरण

{
  "client_id": "example",
  "client_name": "example",
  "redirect_uri": "http://127.0.0.1:8789/oauth/callback",
  "authorization_endpoint": "https://example.com/media.png",
  "token_endpoint": "https://example.com/media.png",
  "scopes": "example"
}