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

دریافت یک نقش

یک نقش به‌طور کامل، با کل فهرست مجوزهایش و اینکه اکنون چه چیزی آن را دارد.

GETapi.openemail.uk/roles/{id}

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

GET /roles/{id}

یک نقش به‌طور کامل، با کل فهرست مجوزهایش و اینکه اکنون چه چیزی آن را دارد.

نمونه

نیازمند roles:read است. شناسه‌ها پیشوند role_ دارند.

curl
curl "$OE/roles/role_2b81de079c1f0a4b7e05d386" -H "$AUTH"
پاسخ
{  "object": "role",  "id": "role_2b81de079c1f0a4b7e05d386",  "name": "Support",  "description": "Answers the shared inboxes and nothing else.",  "permissions": [    "emails:send",    "emails:read",    "threads:read",    "threads:write",    "labels:read",    "labels:write",    "contacts:read"  ],  "builtin": null,  "editable": true,  "deletable": true,  "members": 3,  "apiKeys": 1,  "createdAt": "2026-08-30T10:41:02.000Z",  "updatedAt": "2026-08-30T12:15:44.000Z"}

نقشی روی فضای کاری دیگر یک 404 است نه یک 403، همان پاسخی که شناسه‌ای می‌گیرد که هرگز وجود نداشته، چون گفتن به یک کلید که چه شناسه‌هایی روی فضای کاری‌ای که نمی‌تواند بخواند وجود دارد، خودش همان نشت است.

permissions کل دسترسی است، مسطح و از پیش بسط‌یافته. چیز دیگری برای گرفتن نیست و اندپوینتی به ازای هر مجوز وجود ندارد: یک نقش به صورت یک فهرست خوانده می‌شود چون این فهرست است که بازبینی می‌شود.

این نمی‌گوید چه کسی آن را دارد. members و apiKeys شمارش‌اند؛ نام‌های پشت اولی از GET /members می‌آید، و اندپوینتی که کلیدهای روی یک نقش را فهرست کند وجود ندارد.