curl --request GET \
--url 'https://management.scanova.io/multi-users/' \
--header 'Authorization: YOUR_API_KEY'
{
"count": 0,
"next": null,
"previous": null,
"results": []
}
واجهة الإدارة — المستخدمون المشتركون والأدوار
سرد المستخدمين المشاركين
GET /multi-users/
GET
/
multi-users
/
curl --request GET \
--url 'https://management.scanova.io/multi-users/' \
--header 'Authorization: YOUR_API_KEY'
{
"count": 0,
"next": null,
"previous": null,
"results": []
}
المستخدمون المشاركون هم زملاء الفريق الذين تدعوهم إلى حساب Scanova الخاص بك — نفس القائمة الظاهرة في جدول Users بلوحة التحكم. تتيح لك نقطة النهاية هذه سردهم أو دعوتهم أو تحديثهم أو إزالتهم برمجيًا.
لم تكن نقطة النهاية هذه موثّقة سابقًا. تتطلب مفتاح Management API بحصة
MANAGEMENT_API (أو MANAGEMENT_API_SANDBOX)، يُرسل كقيمة خام لترويسة Authorization — راجع نظرة عامة على Management API — بالإضافة إلى حصة الفريق الخاصة بالحساب للمستخدمين المشاركين. لمعرفة ما يمنحه كل دور فعليًا، راجع الأدوار والصلاحيات؛ وللاطلاع على الصيغة السلكية للأدوار نفسها، راجع الأدوار (مستويات الوصول).curl --request GET \
--url 'https://management.scanova.io/multi-users/' \
--header 'Authorization: YOUR_API_KEY'
{
"count": 0,
"next": null,
"previous": null,
"results": []
}
تم التحقق منه مباشرة مقابل حساب اختباري بلا زملاء مدعوّين بعد — لذا
results فارغة. الشكل أدناه (من المُسلسِل الأساسي) هو ما يبدو عليه كل عنصر بمجرد وجود زملاء.string
تصفية بمطابقة تامة لعنوان البريد الإلكتروني للمستخدم المشارك.
string
مطابقة جزء نصي غير حسّاسة لحالة الأحرف مقابل الاسم الأول للمستخدم المشارك.
string
أسماء أدوار مفصولة بفواصل للتصفية بها، مثل
Admin,Manager.string
واحد من
invitation_sent، active، inactive.string
واحد من
enabled، disabled، pending.string
shared_user__email، shared_user__first_name، أو أيٌّ منهما مسبوق بـ - للترتيب التنازلي.حقول الاستجابة (لكل عنصر)
integer
معرّف سجل المستخدم المشارك — استخدمه كـ
{pk} لنقاط نهاية الاسترجاع/التحديث/الحذف أدناه.object
object
الدور المُسنَد، بنفس الشكل الذي يعيده
GET /multi-users/access-levels/.string
حالة محسوبة:
Invitation Sent، Active، Inactive (لا تسجيل دخول منذ 60 يومًا أو أكثر)، أو Locked.boolean
ما إذا كان حساب المستخدم المشارك فعّالًا (يختلف عن
status — المستخدم المُعطَّل يُظهر دائمًا is_active: false بغض النظر عن حالة الدعوة).string | null
طابع زمني بصيغة ISO 8601 لبريد الدعوة (الأحدث).
string | null
طابع زمني بصيغة ISO 8601 لوقت قبول الدعوة، أو
null إذا كانت لا تزال معلّقة.boolean
إذا كانت صحيحة، تُقيَّد رؤية رموز QR لهذا المستخدم بالوسوم الموجودة في
tags أدناه.boolean
عندما تُفعَّل الصلاحية القائمة على الوسوم، ما إذا كان بإمكان المستخدم أيضًا رؤية رموز QR غير الموسومة.
array
الوسوم التي يقتصر عليها هذا المستخدم (ذات معنى فقط عندما تكون
enable_tag_permission صحيحة)، بصيغة {id, name}.string
string
ذات صلة
- دعوة مستخدم مشارك — العملية الأخرى لنفس نقطة النهاية هذه.
- استرجاع مستخدم مشارك — اعمل على مستخدم مشارك واحد من هذه القائمة.
- تحديث مستخدم مشارك — اعمل على مستخدم مشارك واحد من هذه القائمة.
- إزالة مستخدم مشارك — اعمل على مستخدم مشارك واحد من هذه القائمة.
- سرد الأدوار — ابحث عن معرّف
access_levelأو أنشئه، وهو ما تتطلبه استدعاءات الدعوة/التحديث في نقطة النهاية هذه. - إنشاء دور مخصص — ابحث عن معرّف
access_levelأو أنشئه، وهو ما تتطلبه استدعاءات الدعوة/التحديث في نقطة النهاية هذه. - المستخدمون المشاركون — جدول Users الخاص بلوحة التحكم نفسها، يعرض نفس إجراءات الدعوة/التعطيل/الإزالة.
- الأدوار والصلاحيات — ما يمنحه كل دور فعليًا لزميل.
التفويضات
Send your Management API key as the raw value of the Authorization header — no "Bearer " or "Token " prefix, and no other characters. Example: Authorization: 401f7ac837da42b97f613d789819ff93537bee6a. A header containing more than one space-separated part is rejected outright. Requests also require the request's Host header to be the management API host (e.g. management.scanova.io) — the same key sent to the regular API host will not authenticate.
الاستجابة
200 - application/json
Paginated list of shared users invited to this account.
هل كانت هذه الصفحة مفيدة؟
⌘I