انتقل إلى المحتوى
Sursa Developers

GET/v1/groups

عرض مجموعات المستخدمين في المؤسسة

list_groups

دون kind، يعيد المجموعات العادية، و«All members» (كل الأعضاء)، ومجموعات الأدوار. المجموعات الشخصية (single_user) تُعاد فقط مع kind=single_user صريح. عضوية مجموعات all_members وrole وsingle_user تُحسب من مستخدمي المؤسسة، وكذلك قيمة members_count لها.

المصادقة

أرسل مفتاح API في الترويسة Authorization: Authorization: Bearer <key>.

معاملات الاستعلام

  • kindGroupKind
  • limitinteger

    حجم الصفحة. دون المعاملين limit وcursor تُعاد القائمة كاملة؛ ومع المعامل تُعاد عناصر بعدد limit على الأكثر، وتُعطى الصفحة التالية في الترويستين Link (rel="next") وX-Next-Cursor.

    ≥ 1, ≤ 200

  • cursorstring

    مؤشر الصفحة التالية من الترويسة X-Next-Cursor أو من الحقل next_cursor في الاستجابة السابقة بعوامل التصفية نفسها؛ ويحمل حجم الصفحة. مع المعامل offset معًا: 422 validation.failed؛ ومؤشر قائمة أخرى أو عوامل تصفية أخرى أو مؤشر تالف: 400 api.cursor_invalid.

    length ≤ 512

  • updated_sincestring (date-time)

    الكائنات التي تساوي فيها قيمة updated_at هذه اللحظة أو تأتي بعدها فقط (RFC 3339 مع إزاحة التوقيت)، للمزامنة. معه تُرتَّب القائمة حسب updated_at تصاعديًا، ثم حسب id، ويتابع المؤشر بهذا الترتيب. الكائنات المحذوفة لا تظهر في القائمة: الحذف يصل على شكل أحداث.

    length ≤ 512

الاستجابات

200استجابة ناجحة

ترويسات الاستجابة

  • Link

    عنوان الصفحة التالية، <…>; rel="next". غياب الترويسة يعني أن هذه الصفحة الأخيرة.

  • X-Next-Cursor

    مؤشر الصفحة التالية للمعامل cursor. غياب الترويسة يعني أن هذه الصفحة الأخيرة.

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: GroupList

array of Group
  • idintegerمطلوب
  • org_idintegerمطلوب
  • keystringمطلوب

    مفتاح ثابت: all، أو role:<role>، أو user:<id>، أو مفتاح مجموعة مستخدمين عادية. تترجم الواجهة مجموعات المستخدمين المدمجة حسب المفتاح.

  • titlestringمطلوب
  • kindGroupKindمطلوب
  • user_idinteger | nullمطلوب

    لمجموعات المستخدمين الشخصية فقط.

  • role_keyRole | nullمطلوب

    لمجموعات الأدوار فقط.

  • managed_byGroupManagedByمطلوب
  • members_countintegerمطلوب

    عدد الأعضاء النشطين. المستخدمون المعطَّلون ليسوا أعضاء في مجموعات المستخدمين.

  • disabledbooleanمطلوب

    مجموعة المستخدمين الشخصية لمستخدم معطَّل: تُحفظ إسناداتها لكن لا أثر لها ما دام المستخدم غير نشط. القيمة false لكل مجموعات المستخدمين الأخرى.

  • created_atstring (date-time)مطلوب
  • updated_atstring (date-time)مطلوب
401لم تُرسَل بيانات اعتماد (لا ملف تعريف ارتباط للجلسة ولا مفتاح API)، أو لم يُعثر على المفتاح.

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

422خطأ في صحة البيانات: نص الطلب أو المعاملات لا تطابق المخطط (الحقل `detail` قائمة بأخطاء صحة البيانات)، أو قيمة معامل خارج النطاق المسموح (الحقل `detail` رسالة نصية).

ترويسات الاستجابة

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

429طلبات كثيرة جدًا (`api.rate_limited`)، أو استُنفدت حصة المؤسسة للدقيقة أو اليوم أو الشهر (`api.quota_exceeded`؛ يحتوي الحقل `error.details` على `quota` و`limit` و`reset_at`)، أو بلغت المؤسسة حدها، أو خدمة الإجابات مشغولة (`answers.engine_busy`). انتظر المدة المذكورة في الترويسة `Retry-After`.

ترويسات الاستجابة

  • Retry-After

    عدد الثواني التي تنتظرها قبل إعادة محاولة الطلب.

  • RateLimit-Policy

    الحدود السارية، بصيغة مسودة IETF draft-ietf-httpapi-ratelimit-headers: عناصر مفصولة بفواصل "<name>";q=<quota>;w=<window in seconds>. العنصر key هو معدل طلبات مفتاح API (الحصة هي هامش الذروة، والنافذة الزمنية هي مدة إعادة ملئه بالكامل؛ وللجلسة يكون user، ودون بيانات اعتماد ip)؛ وminute وday وmonth هي حصص المؤسسة للدقيقة واليوم والشهر التقويمية بتوقيت UTC.

  • RateLimit

    المتبقي من كل حد في الترويسة RateLimit-Policy: "<name>";r=<remaining>;t=<seconds until reset>.

  • X-RateLimit-Limit

    حد العنصر الأشد صرامة في الترويسة RateLimit-Policy (العنصر الذي بقي فيه أقل عدد من الطلبات).

  • X-RateLimit-Remaining

    عدد الطلبات المتبقية ضمن الحد الأشد صرامة.

  • X-RateLimit-Reset

    عدد الثواني حتى إعادة ضبط الحد الأشد صرامة.

application/json

الكائن: Error

رموز الأخطاء

الرموز التي قد تعيدها نقطة النهاية هذه في error.code، إضافةً إلى الرموز العامة لكل طلب.

حدود المعدل

تحمل الاستجابات الترويستين RateLimit وRateLimit-Policy، والترويسات الأقدم X-RateLimit-Limit وX-RateLimit-Remaining وX-RateLimit-Reset. وفي الاستجابة 429 الترويسة Retry-After بالثواني: انتظر ثم أعد المحاولة.

← groups · مرجع API