الأدوار هي مجموعات الصلاحيات في مساحة عملك. يحمل كل مستخدم من الموظفين دوراً واحداً، ويمنح كل دور مفاتيح من دليل الصلاحيات، وهي المفاتيح نفسها التي يمنحها مسؤول مساحة العمل لتكاملات الواجهة البرمجية. استخدم هذه القائمة (للقراءة فقط) لمراجعة من يستطيع ماذا، أو لمطابقة الأدوار في نظام هويات.
جميع النقاط تحت /api/v1 وتتطلب مفتاح واجهة برمجية (Authorization: Bearer jdr_live_…) ينشئه مسؤول مساحة العمل من الإعدادات ← التكاملات.
النقاط
| الطريقة والمسار | ما تفعله | الصلاحية |
|---|---|---|
GET /api/v1/roles | سرد الأدوار مع مفاتيح صلاحياتها (ترقيم بالمؤشر، updatedSince) | users.view |
الأدوار للقراءة فقط عبر الواجهة البرمجية. تُنشأ وتُعدَّل من الإعدادات ← المستخدمون ← الأدوار.
كائن الدور
| الحقل | النوع | ملاحظات |
|---|---|---|
id | نص | يطابق role.id لدى المستخدم. |
name | كائن | { ar, en }. |
description | نص أو null | |
systemKey | نص أو null | يُضبط على الأدوار المضمّنة: workspace_admin في كل مساحة عمل، والأدوار المُعدّة سابقًا في مساحات العمل التي أُنشئت قبل أن يصبح بناء الأدوار بيد مديريها. null للأدوار التي أنشأها مسؤولوك. |
isWorkspaceAdmin | قيمة منطقية | دور مدير مساحة العمل المقفل: يملك كل الصلاحيات ولا يمكن تعديله. |
dataScope | نص | WORKSPACE (كل السجلات) أو REPORTING_LINE (خط التبعية لحامل الدور فقط). |
permissions | مصفوفة | مفاتيح الدليل الممنوحة، مثل recruitment.act وaudit.view. يسرد دور مدير مساحة العمل كل المفاتيح. و<module>.act تتضمن <module>.view. |
createdAt، updatedAt | ISO 8601 |
أحداث خطافات الويب
| الحدث | متى | data.object |
|---|---|---|
role.created | إنشاء دور | الدور |
role.updated | تغيّر اسمه أو وصفه أو نطاق بياناته أو صلاحياته (changedFields) | الدور |
role.deleted | حذف دور (لا يُحذف إلا دور لا يحمله أحد) | { id, externalRefs: [] } |
يحرّك تغيير الصلاحيات أيضاً updatedAt للدور، فيلتقطه updatedSince. وتُسرد الأدوار المحذوفة في سجل المحذوفات (GET /api/v1/deleted).
الأخطاء
| الحالة والرمز | المعنى |
|---|---|
403 forbidden | المفتاح لا يملك users.view. |
422 validation_failed | قيمة غير صالحة لـ limit أو cursor أو updatedSince. |
مثال
curl "https://jadiroon.com/api/v1/roles?limit=1" -H "Authorization: Bearer $JADIROON_KEY"
{
"data": [
{
"id": "cmviqdaf8004lknffw1rpf3ww",
"name": { "ar": "مدير مساحة العمل", "en": "Workspace Admin" },
"description": null,
"systemKey": "workspace_admin",
"isWorkspaceAdmin": true,
"dataScope": "WORKSPACE",
"permissions": ["planning.view", "planning.act", "…", "audit.view", "audit.export"],
"createdAt": "2026-10-21T22:06:41.011Z",
"updatedAt": "2026-10-21T22:06:41.011Z"
}
],
"nextCursor": "Y212aXFkYWY4MDA0bGtuZmZ3MXJwZjN3dw"
}