Ugrás a dokumentációra
API

Jogosultságok listázása

A teljes szókészlet, minden bejegyzéshez a mondattal és a címsorral, amely alatt megjelenik.

GETapi.openemail.uk/roles/permissions

A valódi hívást futtatja le a munkaterületén, a saját kulcsával.

GET /roles/permissions

A teljes szókészlet, minden bejegyzéshez a mondattal és a címsorral, amely alatt megjelenik.

Példa

roles:read szükséges. Konstans, minden munkaterületre ugyanaz a válasz, és ebből a listából érdemes mátrixot építeni, ahelyett hogy a saját kódodba másolnád át.

curl
curl "$OE/roles/permissions" -H "$AUTH"
Válasz
{  "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    }  ]}

A /roles/{id} ELŐTT van regisztrálva, különben a permissions szerepkör-azonosítóként olvasódna, és minden rá irányuló kérés 404-et adna. A /rules/runs fölött ugyanez a megjegyzés áll, és a /tracking/stats fölött is, mindkettő ugyanazon hiba után született. Egy valóban „permissions” nevű szerepkör lekérése ezért szerepkört kér, és 404-et kap, ami őszinte válasz arra, amit begépeltek.

A scope azt mondja meg, rendelkezhet-e egyáltalán egy API KULCS az adott jogosultsággal. Öttel nem (api-keys:read, api-keys:write, billing:read, billing:write és workspace:manage), mert egyikhez sincs végpont, és egy kulcs nem személy. Ez a jelző teszi lehetővé, hogy egyetlen komponens jelenítse meg a szerepkör-mátrixot és a kulcslétrehozás jelölőnégyzet-listáját is, ahelyett hogy egy második, kézzel karbantartott másolat tartaná nyilván, melyik melyik.

Kiszolgálva, nem átmásolva, ugyanazért, amiért a szabályok mezőlistája is: egy másolt tömbből épített mátrix tovább kínál egy jogosultságot azon a napon is, amikor átnevezik, és soha nem kínálja a múlt héten hozzáadottat. A group az a címsor, amely alatt megjelenik, és undefined helyett other értékre esik vissza. Egy jogosultság, amelyet senki nem lát, egy jogosultság, amelyet senki nem auditál.

A sorrend kanonikus: ebben a sorrendben jön vissza egy tárolt szerepkör permissions tömbje, így egy ezt a listát megjelenítő kliens és egy szerepkört megjelenítő kliens ugyanazokat a jogosultságokat ugyanabban a sorrendben mutatja.

Nincs boríték az object és a data mezőn túl. A szókészlet zárt és rövid, így nincs cursor és nincs hasMore, eltérően az API összes többi listájától.