پرش به مستندات
API

فهرست مجوزها

کل واژگان، با جمله و عنوانی که هر مدخل زیر آن رندر می‌شود.

GETapi.openemail.uk/roles/permissions

فراخوانی واقعی را با کلید خودتان روی فضای کاری شما اجرا می‌کند.

GET /roles/permissions

کل واژگان، با جمله و عنوانی که هر مدخل زیر آن رندر می‌شود.

نمونه

نیازمند roles:read است. یک ثابت، همان پاسخ برای هر فضای کاری، و همان فهرستی که باید ماتریس را از رویش ساخت به جای رونویسی‌اش در کد خودتان.

curl
curl "$OE/roles/permissions" -H "$AUTH"
پاسخ
{  "object": "list",  "data": [    {      "object": "permission",      "id": "emails:send",      "label": "Send email",      "group": "mail",      "scope": true    },    {      "object": "permission",      "id": "members:write",      "label": "Add and remove people, and change what they can reach",      "group": "people",      "scope": true    },    {      "object": "permission",      "id": "api-keys:write",      "label": "Create and revoke API keys",      "group": "developer",      "scope": false    },    {      "object": "permission",      "id": "workspace:manage",      "label": "Rename the workspace, remove domains and delete it",      "group": "workspace",      "scope": false    }  ]}

پیش از /roles/{id} ثبت شده، وگرنه permissions به عنوان شناسهٔ نقش خوانده می‌شود و هر درخواستی به آن 404 می‌گیرد. /rules/runs همین یادداشت را بالای خود دارد و /tracking/stats هم بالاتر از آن، که هر دو پس از همان باگ نوشته شده‌اند. پس درخواست نقشی که واقعاً «permissions» نام دارد درخواست یک نقش است و 404 می‌گیرد، که پاسخ صادقانه به چیزی است که تایپ شده.

scope می‌گوید که آیا یک کلید API اصلاً می‌تواند آن مجوز را داشته باشد. پنج‌تا نمی‌توانند (api-keys:read، api-keys:write، billing:read، billing:write و workspace:manage) چون برای هیچ‌کدام اندپوینتی وجود ندارد و کلید شخص نیست. همان پرچم است که می‌گذارد یک کامپوننت هم ماتریس نقش‌ها و هم فهرست تیک‌های ساخت کلید را رندر کند، به جای نسخهٔ دومی که دستی نگه داشته شود.

سرو می‌شود نه رونویسی، به همان دلیلی که فهرست فیلدهای قانون‌ها می‌گوید: ماتریسی که از روی آرایه‌ای کپی‌شده ساخته شود روزی که مجوزی تغییر نام دهد باز هم آن را پیشنهاد می‌دهد و مجوزی را که هفتهٔ پیش افزوده شده هرگز پیشنهاد نمی‌دهد. group عنوانی است که مدخل زیر آن رندر می‌شود و به جای رفتن با مقدار undefined به other برمی‌گردد. مجوزی که کسی نمی‌بیند مجوزی است که کسی بازبینی‌اش نمی‌کند.

ترتیب متعارف است: همان ترتیبی که آرایهٔ permissions یک نقش ذخیره‌شده با آن برمی‌گردد، پس کلاینتی که این فهرست را رندر می‌کند و کلاینتی که یک نقش را رندر می‌کند همان مجوزها را در همان توالی نشان می‌دهند.

پاکتی جز object و data ندارد. واژگان بسته و کوتاه است، پس برخلاف هر فهرست دیگری در این API نه cursor دارد و نه hasMore.