يُحمّل البحث عند استخدامه فقط. تصفّح جميع الفئات أدناه.

تهيئة المصادقة

مصادقة الوكيل: request

بدء دخول الوكيل ليفتح المستخدم المتصفح ويختار ما يفوّضه. نقطة النهاية خارج قائمة api post المسموحة. أبقِ تفاصيل جلسة الدخول خاصة.

POST /identity-api/agent-auth/request

مراجعة العقد: · sha256:563d2d581da0ad29

نظرة عامة

بدء دخول الوكيل ليفتح المستخدم المتصفح ويختار ما يفوّضه. نقطة النهاية خارج قائمة api post المسموحة. أبقِ تفاصيل جلسة الدخول خاصة.

قد يعني نجاح HTTP قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.

تنتمي نقطة النهاية لبروتوكول الدخول ولا تتاح عبر api post. استخدم مسار الدخول المدعوم بالمتصفح وأبقِ بيانات الجلسة خارج المخرجات والسجلات.

المصادقة والأذونات

فئات بيانات الاعتماد المقبولة
delegated_oauth
إمكانية مفوّضة
oauth-bootstrap
الحد الأدنى لدور مساحة العمل
لا حد أدنى لدور مساحة العمل في هذا العقد؛ تظل فحوص الملكية والتفويض سارية.
نطاق الوصول
الموارد التي يحق لهذا المستخدم الوصول إليها
تلزم موافقة تشمل جميع مساحات العمل
لا
يغيّر الحالة
لا
متى تُعدّ العملية مكتملة
not_agent_callable

لا يستخدم الرمز إلا حقوق مالكه. يفحص كل طلب عضوية مساحة العمل وملكية المورد والمساحات المحددة والإمكانات الممنوحة. يغيّر core و full الأدوات المعروضة؛ ولا يمنحان وصولاً.

حقول الطلب

تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.

حقول الطلب
الحقل / الفرعالنوع / مطلوبالقيود
$objectمطلوب في العنصر الأب
  • additionalProperties: false
client_namestringمطلوب في العنصر الأب
  • minLength: 1
  • maxLength: 80
device_namestringمطلوب في العنصر الأب
  • minLength: 1
  • maxLength: 120
callback_uristringمطلوب في العنصر الأب—
callback_urianyOf 1stringمطلوب في العنصر الأب
  • const: "http://127.0.0.1:8789/grant/callback"
callback_urianyOf 2stringمطلوب في العنصر الأب
  • format: "uri"
  • maxLength: 2048
  • pattern: "^https:\\/\\/.*"
callback_statestringمطلوب في العنصر الأب
  • minLength: 32
  • maxLength: 256
مخطط JSON Schema الكامل
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "client_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "device_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "callback_uri": {
      "anyOf": [
        {
          "type": "string",
          "const": "http://127.0.0.1:8789/grant/callback"
        },
        {
          "type": "string",
          "maxLength": 2048,
          "format": "uri",
          "pattern": "^https:\\/\\/.*"
        }
      ]
    },
    "callback_state": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256
    }
  },
  "required": [
    "client_name",
    "device_name",
    "callback_uri",
    "callback_state"
  ],
  "additionalProperties": false
}

الاستجابة والاكتمال

رموز نجاح HTTP: 200. عندما تكتمل العملية: not_agent_callable.

قد يعني نجاح HTTP قبول الطلب لا اكتماله. للعمل الخلفي، احفظ المعرّف المُعاد وتابع العملية نفسها حتى تنتهي. لا يُعدّ المنشور المجدول أوالمقبول منشوراً حتى تأكيد المنصة؛ انتهاء مهلة العميل لا يثبت النتيجة.

تعني «مطلوب» داخل الكائن الأب والفرع المختار. الحقل الابن المطلوب لا يجعل الأب الاختياري مطلوباً. نُسخت القواعد وأسماء الحقول أدناه من العقد.

الاستجابة والاكتمال
الحقل / الفرعالنوع / مطلوبالقيود
$objectمطلوب في العنصر الأب—
request_idstringمطلوب في العنصر الأب
  • format: "uuid"
  • pattern: "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
approval_urlstringمطلوب في العنصر الأب
  • format: "uri"
expires_inintegerمطلوب في العنصر الأب
  • maximum: 9007199254740991
  • exclusiveMinimum: 0
مخطط JSON Schema الكامل
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "approval_url": {
      "type": "string",
      "format": "uri"
    },
    "expires_in": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "request_id",
    "approval_url",
    "expires_in"
  ]
}

الأخطاء وإعادة المحاولة بأمان

افحص حالة HTTP والجسم. قد يحوي خطأ التحقق 400 ‏ZodError؛ تستخدم أخطاء المعالج error و message و code. احتفظ بـ request_id أو x-request-id للتشخيص دون اعتماد. أصلح أخطاء وصول 401/403 قبل المحاولة واتّبع Retry-After لـ 429. لكتابة غير مؤكدة أو 5xx، اقرأ الموجود أولاً. أعِد مفتاح منع التكرار حيث يُدعم فقط؛ تختلف المحاولة حسب العملية ولا تضمن التسليم مرة واحدة بالضبط.

دليل استكشاف الأخطاء وإصلاحها

أمثلة

تستخدم الأمثلة قيماً خيالية مفحوصة بالمخططات. استبدل المعرّفات بالمفوّض لك، والوسائط بأصول جاهزة، والتواريخ بوقت نشر مؤكد. افحص أهلية الحساب قبل الكتابة. لا تُرسل الصفحة طلبات API.

اضبط SOSOAPI_ACCESS_TOKEN على خادمك ببيانات اعتماد تقبلها العملية، وأبقِه خارج شيفرة المتصفح. للوكيل، استخدم sosoapi auth login للدخول بالمتصفح ودع CLI يحدّث بيانات اعتماده.

request.json

{
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
}

cURL

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

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

مثال استجابة اصطناعية

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "approval_url": "https://example.com/media.png",
  "expires_in": 1
}