Přejít na dokumentaci
API

Úprava role

Všechna pole jsou volitelná a `permissions` nahradí celý seznam.

PATCHapi.openemail.uk/roles/{id}

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

PATCH /roles/{id}

Všechna pole jsou volitelná a permissions nahradí celý seznam.

Příklad

Vyžaduje roles:write. Vynechané pole zůstane beze změny, což je přesně to, co PATCH znamená.

curl
curl -X PATCH "$OE/roles/role_2b81de079c1f0a4b7e05d386" -H "$AUTH" \  -H "Content-Type: application/json" \  -d '{ "permissions": ["emails:read", "threads:read", "labels:read", "contacts:read"] }'
Odpověď
{  "object": "role",  "id": "role_2b81de079c1f0a4b7e05d386",  "name": "Support",  "description": "Answers the shared inboxes and nothing else.",  "permissions": ["emails:read", "threads:read", "labels:read", "contacts:read"],  "builtin": null,  "editable": true,  "deletable": true,  "members": 3,  "apiKeys": 1,  "createdAt": "2026-08-30T10:41:02.000Z",  "updatedAt": "2026-08-30T13:02:19.000Z"}

permissions NAHRAZUJE celý seznam. Volání pro udělení jednoho oprávnění neexistuje a nebude: audituje se seznam a patch adresovaný indexem je ztracená aktualizace ve chvíli, kdy jsou otevřené dvě karty. Přečtěte roli, změňte položku, kterou jste chtěli, a pošlete zpátky všechny. Poslat jedno oprávnění neznamená jedno oprávnění přidat. Znamená to, že role bude držet přesně to jedno plus to, co z něj plyne.

description je nejen volitelný, ale i nullable, a ten rozdíl je celý smysl patche: vynechání ponechá uloženou větu, poslání null ji smaže. Bez nullable by nešlo popis odstranit jinak než tím, že ho nahradíte mezerou.

Vlastník je jediná role, kterou PATCH odmítne, a odmítne u ní každé pole: role_immutable, 409 s param: "roleId". Všechno ostatní přijme nové jméno stejně ochotně jako nový seznam oprávnění, základní role v to počítaje. builtin zaznamenává, odkud role vzešla, ne co se s ní smí dělat. Jméno, které už drží jiná role, je naproti tomu role_name_taken, 409 s param: "name".

Úprava se projeví při DALŠÍM požadavku kohokoli, kdo roli drží, API klíče v to počítaje, protože strop se vyhodnocuje při každém požadavku, místo aby se ukládal do keše. Zúžení role je tedy okamžité odebrání práv, které platí, aniž by se klíče pod ní musely rotovat. Rozšíření je stejně okamžité, a to je ta polovina, kterou stojí za to si pamatovat.