API

Përditëso një rol

Çdo fushë opsionale, dhe `permissions` zëvendëson të gjithë listën.

PATCHapi.openemail.uk/roles/{id}

Ekzekuton thirrjen reale kundrejt hapësirës suaj të punës, me çelësin tuaj.

PATCH /roles/{id}

Çdo fushë opsionale, dhe permissions zëvendëson të gjithë listën.

Shembull

Kërkon roles:write. Lënia jashtë e një fushe e lë atë të paprekur, që është ajo çka do të thotë PATCH.

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"] }'

Përgjigje

{  "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 E ZËVENDËSON të gjithë listën. Nuk ka thirrje që jep një leje të vetme dhe nuk do të ketë: lista është ajo që auditohet, dhe një patch i adresuar me indeks është një humbje shkrimi që në momentin kur hapen dy skeda. Lexoni rolin, ndryshoni zërin që kishit parasysh, dërgojini të gjitha prapa. Dërgimi i një leje të vetme nuk shton një leje. Ai e lë rolin duke mbajtur pikërisht atë të vetmen, plus çfarëdo që ajo nënkupton.

description është nullable po aq sa opsionale, dhe dallimi është pikërisht qëllimi i një patch-i: lënia e saj jashtë ruan fjalinë e ruajtur, ndërsa dërgimi i null e pastron. Pa nullable-in nuk do të kishte mënyrë për ta hequr një përshkrim përveçse duke e zëvendësuar me një hapësirë.

Owner-i është i vetmi rol që një PATCH e refuzon, dhe e refuzon në çdo fushë të tij: role_immutable, një 409 me param: "roleId". Çdo gjë tjetër pranon një emër të ri po aq lehtë sa një listë të re lejesh, përfshirë rolet fillestare. builtin regjistron nga vjen një rol, jo çfarë mund t'i bëhet. Një emër që e mban tashmë një rol tjetër është role_name_taken, një 409 me param: "name".

Ndryshimi zë vend në kërkesën e RADHËS të bërë nga kushdo që e mban rolin, përfshirë çelësat API, sepse tavani zgjidhet për çdo kërkesë dhe nuk ruhet në cache. Ngushtimi i një roli është pra një revokim i drejtpërdrejtë që hyn në fuqi pa u rrotulluar çelësat nën të. Edhe zgjerimi është i drejtpërdrejtë, dhe kjo është gjysma që ia vlen të mbahet mend.