الانتقال إلى المحتوى الرئيسي
POST
إنشاء نطاق

إنشاء نطاق

POST /v1/scopes ينشئ نطاق إذن مخصص للمستأجر المصادق عليه. توسع النطاقات المخصصة سجل النطاقات المدمج بأذونات خاصة بالمستأجر. يتم تكوين سلسلة النطاق تلقائيًا من حقلي resource و action بتنسيق resource:action. يتم التحقق من النطاقات المخصصة مقابل قواعد تنسيق نطاق MAIP: أحرف أبجدية رقمية ونقاط وشرطات سفلية وواصلات وعلامات نجمية فقط.
النطاقات المخصصة معزولة للمستأجر. لا تظهر في نطاق المستأجرين الآخرين السجلات. لا يمكن تجاوز نطاقات النظام الأساسي المضمنة أو تكرارها.

المصادقة

يتطلب رأس X-API-Key أو رمز Bearer JWT. يتم اشتقاق مساحة العمل من بيانات الاعتماد الموثقة؛ لا ترسل X-Tenant-ID.

الاستجابة

string
معرف UUID لتعريف النطاق الذي تم إنشاؤه حديثًا.
string
معرف UUID للمستأجر المالك.
string
سلسلة النطاق المركبة بتنسيق resource:action.
string
مكون المورد.
string
مكون الإجراء.
string
اسم النطاق المقروء بشريًا.
string
وصف النطاق.
string
فئة النطاق.
boolean
دائمًا false للنطاقات التي أنشأها المستأجر.
string
طابع زمني لإنشاء ISO 8601.

مثال


تعيين نطاقات مخصصة للوكلاء

بعد إنشاء نطاق مخصص، قم بتعيينه للوكلاء أثناء التسجيل أو عبر التفويض:

التفويضات

X-API-Key
string
header
مطلوب

مفتاح API للمصادقة من جهاز إلى جهاز

الجسم

application/json
action
string
مطلوب

مكون الإجراء للنطاق (مثل "قراءة"، "موافقة"، "*")

resource
string
مطلوب

مكون المورد للنطاق (مثل "crm"، "payment")

category
string

الفئة التنظيمية (الافتراضي هو "مخصص")

description
string

وصف تفصيلي لما يمنحه النطاق

display_name
string

اسم مقروء بشريًا للنطاق

الاستجابة

تم إنشاء النطاق

id
string<uuid>
tenant_id
string<uuid>
scope
string
resource
string
action
string
display_name
string
description
string
category
string
is_builtin
boolean
created_at
string<date-time>