API

Izveidot lomu

Nosaukums un atļauju saraksts. Atpakaļ nāk garāks saraksts, nekā nosūtījāt.

POSTapi.openemail.uk/roles

Izpilda īstu izsaukumu pret jūsu darbvietu, ar jūsu paša atslēgu.

POST /roles

Nosaukums un atļauju saraksts. Atpakaļ nāk garāks saraksts, nekā nosūtījāt.

Piemērs

Nepieciešams roles:write. Atgriež 201. Pielāgotai lomai ir builtin: null, editable: true un deletable: true, un to netur neviens, kamēr kāds uz to nav pārvietots.

curl

curl -X POST "$OE/roles" -H "$AUTH" -H "Content-Type: application/json" \  -d '{    "name": "Support",    "description": "Answers the shared inboxes and nothing else.",    "permissions": ["emails:send", "threads:write", "labels:write", "contacts:read"]  }'

Atbilde

{  "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": 0,  "apiKeys": 0,  "createdAt": "2026-08-30T10:41:02.000Z",  "updatedAt": "2026-08-30T10:41:02.000Z"}

Iekšā aizgāja četras atļaujas, atpakaļ atnāca septiņas. emails:send ietver emails:read, threads:write ietver threads:read, labels:write ietver labels:read. Loma, kas drīkst arhivēt pavedienu, kuru nevar atvērt, ir izvēles rūtiņa, ko kāds aizmirsa, nevis politika, ko kāds domā, tāpēc ietvērums tiek saglabāts, nevis atteikts. Saraksts atgriežas arī kanoniskā kārtībā, un tieši tas ļauj klientam salīdzināt divas lomas kā JSON un izlemt, vai Save ir aktīvs.

Nezināma atļauja šeit TIEK atteikta, nevis izmesta: templates:writ ir invalid_parameter, 422, nosaucot virkni. Pakalpojums normalizē klusējot, jo tas ir arī sākotnējās aizpildes ceļš un MCP ceļš, kur veselas lomas atteikšana viena neatpazīta vārda dēļ būtu sliktāk. Izsaukumā, ko kāds veicis apzināti, tas ir nepareizi. 200 ar lomu, kas nevar rediģēt veidnes, viņam neko nav pateicis, un viņš pavadīs pēcpusdienu, to meklējot.

Dubults nosaukums vienā darbvietā ir role_name_taken, 409. 25. pielāgotā loma ir role_limit_reached, 422. Tas ierobežo, cik liela matrica var kļūt, pirms to vairs neviens neauditē, un nav plāna robeža.

Lomas izveide to nevienam nepiešķir. Cilvēku pārvietošana uz to ir PATCH /members/{userId}, bet atslēgas norādīšana uz to notiek tur, kur atslēga tiek izdota.