Přejít na dokumentaci
API

Výpis oprávnění

Celý slovník, s větou a nadpisem, pod kterým se každá položka vykresluje.

GETapi.openemail.uk/roles/permissions

Spustí skutečné volání proti vašemu pracovnímu prostoru, s vaším vlastním klíčem.

GET /roles/permissions

Celý slovník, s větou a nadpisem, pod kterým se každá položka vykresluje.

Příklad

Vyžaduje roles:read. Konstanta, stejná odpověď pro každý pracovní prostor, a seznam, ze kterého se má matice stavět, místo aby se přepisoval do vašeho kódu.

curl
curl "$OE/roles/permissions" -H "$AUTH"
Odpověď
{  "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    }  ]}

Registruje se PŘED /roles/{id}, jinak se permissions čte jako id role a každý požadavek na ni skončí 404. /rules/runs nese nad sebou stejnou poznámku a /tracking/stats také, obě vznikly po téže chybě. Žádost o roli, která se opravdu jmenuje „permissions“, tedy žádá o roli a dostane 404, což je poctivá odpověď na to, co bylo napsáno.

scope říká, jestli oprávnění vůbec smí držet API KLÍČ. Pět jich nesmí (api-keys:read, api-keys:write, billing:read, billing:write a workspace:manage), protože pro žádné z nich není endpoint a klíč není člověk. Právě díky tomuto příznaku může jedna komponenta vykreslit jak matici rolí, tak seznam zaškrtávátek při vytváření klíče, místo druhé ručně udržované kopie toho, co kam patří.

Servírováno, ne opsáno, ze stejného důvodu, jaký uvádí seznam polí u pravidel: matice postavená ze zkopírovaného pole nabízí ve chvíli přejmenování dál staré oprávnění a to přidané minulý týden nenabídne nikdy. group je nadpis, pod kterým se položka vykreslí, a místo undefined spadne na other. Oprávnění, které nikdo nevidí, je oprávnění, které nikdo neaudituje.

Pořadí je kanonické: je to pořadí, v jakém se vrací pole permissions uložené role, takže klient vykreslující tento seznam a klient vykreslující roli ukážou táž oprávnění ve stejném sledu.

Žádná obálka nad rámec object a data. Slovník je uzavřený a krátký, takže tu na rozdíl od každého jiného seznamu v API není kurzor ani hasMore.