Listo rolet

Çdo rol në hapësirën e punës, të integruarit të parët, me numrin e njerëzve dhe çelësave që mbajnë secilin.

export OE=https://api.openemail.ukexport AUTH="Authorization: Bearer $OPENEMAIL_API_KEY"

Një ROL thotë çfarë mund të BËJË dikush në këtë hapësirë pune: të lexojë postën, ta dërgojë atë, të redaktojë shabllone, të shtojë një domen. Një DHËNIE thotë mbi cilat ADRESA mund ta bëjë atë, dhe rri ngjitur te /members/{userId}/addresses si member (lexon adresën dhe dërgon si ajo) ose viewer (vetëm e lexon). Të dyja duhet të pajtohen përpara se të niset një mesazh: një rol që mban emails:send pa asnjë dhënie nuk mund të dërgojë nga asgjë, dhe as çdo adresë e hapësirës së punës nën një dhënie viewer nuk mund të dërgojë nga asgjë.

Çdo hapësirë pune krijohet fillimisht me të njëjtat gjashtë role. Owner, Admin, Member dhe Viewer formojnë një shkallë. Secili mban gjithçka që mban ai pas tij, prandaj ulja e dikujt në gradë ia ngushton aksesin në vend që t'ia këmbejë me një pjesë tjetër. Developer dhe Billing nuk janë shkallare të saj: Developer ndërton integrime (çelësa, webhook-ë, shabllone, dërgim) dhe nuk lexon asnjë mesazh të hapësirës së punës, ndërsa Billing sheh planin e faturat dhe asgjë tjetër. Të dy rrinë rreptësisht brenda Admin. Ata krijohen fillimisht në leximin e parë dhe jo në krijimin e hapësirës së punës, prandaj një hapësirë pune e bërë përpara se të ekzistonte kjo veçori i fiton ato në çastin që i kërkon diçka. builtin emërton nga cili shabllon fillestar vjen një rresht, dhe kaq emërton: të gjashtët janë një pikënisje që një hapësirë pune duhet ta formësojë, dhe secili prej tyre përveç Owner mund të riemërtohet, t'i ndryshohen lejet dhe të fshihet. Degëzoni mbi editable dhe deletable dhe jo mbi emrin: një rol që dikush e riemërtoi u përgjigjet ende saktë atyre të dyjave, ndërsa emri i tij nuk ju thotë më asgjë.

Owner-i është i vetmi përjashtim, dhe është përjashtim në çdo drejtim: editable: false, deletable: false, dhe i refuzuar si objektiv te PATCH /members/{userId}. Ai përshkruan llogarinë me të cilën është çelësuar hapësira e punës dhe mban çdo leje, përfshirë ato të shtuara në një publikim të mëvonshëm, prandaj lista e tij llogaritet dhe nuk ruhet. Ta bësh dikë tjetër owner është transferim i hapësirës së punës; këtu nuk ka asnjë endpoint që e kryen një të tillë.

Pesë të tjerët pranojnë gjithçka: një listë të re lejesh, një përshkrim të ri, një emër të ri, një DELETE. Ata janë parazgjedhje fillestare dhe jo pajisje fikse: një hapësirë pune që nuk ndërton kurrë një integrim duhet të mund të heqë qafe Developer, dhe një tjetër ku “Member” do të thotë diçka më e ngushtë duhet të mund ta thotë me fjalët e veta. Vetëm owner-i refuzon, dhe i refuzon të gjitha nën një kod të vetëm: role_immutable, një 409 që mbart param: "roleId", qoftë kur PATCH-i mbante një emër, qoftë një listë lejesh. Asnjë riemërtim nuk refuzohet më më vete, prandaj nuk ka pandryshueshmëri me param: "name" për t'u trajtuar; i vetmi 409 që mund të ngrejë ende një emër është role_name_taken, kur një rol tjetër i hapësirës së punës i përgjigjet tashmë atij.

Përtej të gjashtëve, një hapësirë pune shkruan deri në 24 role të vetat. Tavani numëron vetëm ato, prandaj fshirja e një roli fillestar nuk blen vend nën të. Lejet ZGJEROHEN gjatë hyrjes në vend që të merren fjalë për fjalë (templates:write i vetëm ruhet si templates:read dhe templates:write), prandaj lexojeni listën prapa nga përgjigjja në vend që të supozoni se është ajo që dërguat.

Kërkon roles:read. Pa kursor. Zarfi mbart hasMore dhe nextCursor që një klient t'ia japë të njëjtit kod liste si çdo koleksion tjetër, dhe nuk ka kurrë faqe të dytë.

curl "$OE/roles" -H "$AUTH"

{  "object": "list",  "data": [    {      "object": "role",      "id": "role_1c94e05d3862c1f0a44b7f3a",      "name": "Owner",      "description": "The person the workspace belongs to. Holds everything, including additions.",      "permissions": ["emails:send", "emails:read", "…", "workspace:manage"],      "builtin": "owner",      "editable": false,      "deletable": false,      "members": 0,      "apiKeys": 2,      "createdAt": "2026-08-01T09:00:00.000Z",      "updatedAt": "2026-08-01T09:00:00.000Z"    },    {      "object": "role",      "id": "role_c40a95f21cc65d31c2a89e07",      "name": "Viewer",      "description": "Reads the mail on the addresses they hold, and changes nothing.",      "permissions": [        "emails:read",        "drafts:read",        "threads:read",        "labels:read",        "contacts:read",        "calendar:read",        "templates:read",        "rules:read",        "connections:read",        "settings:read"      ],      "builtin": "viewer",      "editable": true,      "deletable": true,      "members": 3,      "apiKeys": 1,      "createdAt": "2026-08-01T09:00:00.000Z",      "updatedAt": "2026-08-01T09:00:00.000Z"    }  ],  "hasMore": false,  "nextCursor": null}