दस्तावेज़ पर जाएँ
API

भूमिका प्राप्त करें

एक भूमिका पूरी, उसकी समूची अनुमति-सूची और वर्तमान में उसे कौन रखता है, के साथ।

GETapi.openemail.uk/roles/{id}

असली कॉल आपकी अपनी कुंजी से आपके वर्कस्पेस पर चलाता है।

GET /roles/{id}

एक भूमिका पूरी, उसकी समूची अनुमति-सूची और वर्तमान में उसे कौन रखता है, के साथ।

उदाहरण

roles:read चाहिए। ids पर 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"}

दूसरे वर्कस्पेस की भूमिका 403 नहीं, 404 है — वही जवाब जो उस id का होता जो कभी थी ही नहीं, क्योंकि किसी कुंजी को यह बताना कि उस वर्कस्पेस पर कौन-सी ids मौजूद हैं जिसे वह पढ़ नहीं सकती, अपने आप में ही रिसाव है।

permissions पूरा ग्रांट है, सपाट और पहले से विस्तारित। लाने को और कुछ नहीं है और प्रति-अनुमति कोई एंडपॉइंट नहीं: भूमिका एक सूची के रूप में पढ़ी जाती है क्योंकि ऑडिट सूची का ही होता है।

यह नहीं बताता कि उसे कौन रखता है। members और apiKeys गिनतियाँ हैं; पहली के पीछे के नाम GET /members देता है, और ऐसा कोई एंडपॉइंट नहीं जो किसी भूमिका की कुंजियाँ सूचीबद्ध करे।