openemail.roles
Çdo metodë në këtë hapësirë emrash: nënshkrimi, parametrat, çfarë kthen dhe një shembull.
Metodat
What a member or an API key may do, drawn from one permission vocabulary.
roles.list()
List every role in the workspace
list(options?: ListOptions): Promise<Page<RoleResource>>Resolves one page of the roles the workspace defines. listAll collects every page and iterate walks them lazily. The seeded roles come first in ladder order (Owner, Admin, Member, Viewer, Developer, Billing) and custom roles follow alphabetically. The order is read from builtin, so a renamed seeded role keeps its place.
A workspace older than roles has no role rows, and the first read seeds them instead of returning an empty list. Seeding runs once per workspace, and afterwards only the owner role is ever restored, so a seeded role you delete stays deleted. Each row carries members and apiKeys counts computed at read time.
A role is a ceiling for the keys issued under it. What a key may do is its own scopes intersected with its role's permissions, resolved on every request, so a key holding emails:send under a role without it cannot send. A key with no role has no ceiling.
Parametrat
options.limitnumberPage size, from 1 to 100. The server defaults to 25.
options.cursorstringThe
nextCursorof the previous page. Leave it out for the first page.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
Page<RoleResource> with items, hasMore and nextCursor. Each item has id, name, description, permissions, builtin, editable, deletable, members, apiKeys, createdAt and updatedAt.
Shembull
const roles = await openemail.roles.listAll() const custom = roles.filter((role) => role.builtin === null) console.log(roles.map((role) => [role.name, role.members, role.apiKeys]))console.log(custom.length)Shënime
Branch on
editableanddeletablerather than onbuiltin. Both are false only for the owner role.memberscounts people with an explicit membership, so implied members frommembers.listare not counted.apiKeyscounts unrevoked keys only.A workspace holds at most 24 custom roles. Seeded roles do not count toward that.
The cursor is opaque and holds where the last row sat in this order, so a row deleted or edited between pages never breaks the walk: the next page starts at the first row that sorts after it. A cursor this list did not hand out is a 400
invalid_cursor.
E disponueshme edhe në
roles.listAll()
Collect every role into one array
listAll(options?: ListOptions): Promise<Array<RoleResource>>Walks every page of list and resolves with all roles, seeded roles first in ladder order, then custom roles alphabetically. One request per page.
Parametrat
options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Kthen
Array<RoleResource> holding every role.
Shembull
const all = await openemail.roles.listAll({ limit: 100 }) console.log(all.length)Shënime
If any page fails the promise rejects and the roles already fetched are discarded.
E disponueshme edhe në
- API
GET /roles
roles.iterate()
Stream the roles one at a time
iterate(options?: ListOptions): AsyncGenerator<RoleResource, void, undefined>Returns an async generator that yields roles individually, seeded roles first in ladder order, then custom roles alphabetically, and requests the next page only once the current one is drained. Nothing is fetched until you consume it, and breaking out of the loop stops the requests.
Parametrat
options.limitnumberPage size for each request, from 1 to 100. The server defaults to 25.
options.cursorstringStarts the walk after this cursor instead of the first page.
options.signalAbortSignalCancels the request in flight and the walk with it.
options.apiKeystringOverrides the client API key for every page of this walk.
Kthen
AsyncGenerator<RoleResource, void, undefined> yielding one role per step.
Shembull
for await (const item of openemail.roles.iterate()) { console.log(item)}Shënime
The generator is lazy, so an abandoned loop costs only the pages you consumed.
E disponueshme edhe në
- API
GET /roles
roles.get()
Read one role with its usage counts
get(id: string, options?: RequestScope): Promise<RoleResource>Resolves a single role by id. There is no lookup by name, because every role's name except the owner's can be edited.
members and apiKeys are counted when you call rather than stored, so they describe what a deletion would have to move right now. permissions is the stored list with implied permissions already expanded, in canonical order, so it can be longer than what was sent when the role was written.
Parametrat
idstringE detyrueshmeRole id,
role_followed by 24 hex characters. Roles have no lookup by name.options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
RoleResource with permissions, builtin, the editable and deletable flags, and live members and apiKeys counts.
Shembull
const role = await openemail.roles.get('role_8b1f4c2e9a7d3b60e5f1a2c4') console.log(role.name, role.permissions)console.log(role.members, role.apiKeys)Shënime
An unknown id, or one from another workspace, is 404
role_not_foundwithparamset toroleId. The two answer the same way on purpose, so a 404 does not tell you whether the role exists somewhere else.builtinrecords which template a row was seeded from and survives a rename. It is provenance and sort order, not protection.
E disponueshme edhe në
roles.create()
Create a custom role
create(body: RoleCreate, options?: RequestScope): Promise<RoleResource>Writes a role the workspace defines for itself. builtin comes back null and both usage counts are zero. Only roles like this count toward the ceiling of 24 custom roles, past which the call is 422 role_limit_reached.
Implied permissions are expanded as the role is stored, so templates:write alone comes back holding templates:read too, and roles:write brings roles:read and members:read. Read the final list off the result rather than the request. A string that is not in the vocabulary is refused with 422 invalid_parameter rather than dropped.
Be careful with roles:write. Authority is resolved per request, so a key holding it can edit the very role that caps it and widen itself on the next call. Keep it off keys that only need to read.
Parametrat
body.namestringE detyrueshmeAt most 48 characters after trimming, unique per workspace ignoring case. Blank is a 422.
body.permissionsArray<Permission>E detyrueshmeWhat the role grants, drawn from
listPermissions. An empty array is accepted and makes a role that can do nothing.body.descriptionstringOne sentence about who the role is for, at most 240 characters. Blank is stored as null.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
RoleResource with the expanded permissions, builtin: null, editable and deletable true, and members and apiKeys at 0.
Shembull
const support = await openemail.roles.create({ name: 'Support', description: 'Answers help@ and nothing else.', permissions: ['threads:write', 'emails:send', 'templates:read']}) console.log(support.id, support.permissions)Shënime
A name that matches an existing role ignoring case, seeded roles included, is 409
role_name_takenwithparamset toname.A permission the calling key or access token does not hold is refused with 403
insufficient_authority. None of them can hold a console-only permission, the oneslistPermissionsmarks withscope: false, so a role withaddresses:all,billing:writeorworkspace:managein it is written in the app, never through the API.Not retried automatically. After a network failure the role may already exist, and creating it again is
role_name_taken.
E disponueshme edhe në
roles.update()
Rename a role or replace what it grants
update(id: string, patch: RolePatch, options?: RequestScope): Promise<RoleResource>Patches the name, description or permission list of a role. Every seeded role except Owner takes all three, so renaming Billing to Finance and rewriting what it grants is an ordinary update. The owner role refuses any edit with 409 role_immutable.
permissions replaces the whole list and is expanded with implied permissions on the way in. There is no way to add or remove one entry, so read the role, change the array and send all of it. Leave a field out to keep it, and send description: null to clear the note.
The change is live. Authority is resolved on every request, so narrowing a role takes effect for its members and keys on their next call without rotating anything, and widening it takes effect just as fast.
Parametrat
idstringE detyrueshmeRole id,
role_followed by 24 hex characters. Roles have no lookup by name.patch.namestringNew name, at most 48 characters after trimming and unique per workspace ignoring case. Blank is a 422.
patch.descriptionstring | nullNew note of at most 240 characters. Null or blank clears it.
patch.permissionsArray<Permission>Complete replacement list, expanded with implied permissions before it is stored.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
RoleResource as saved, with live members and apiKeys counts.
Shembull
const role = await openemail.roles.get('role_8b1f4c2e9a7d3b60e5f1a2c4') const updated = await openemail.roles.update(role.id, { name: 'Finance', permissions: [...role.permissions, 'domains:read']}) console.log(updated.name, updated.permissions)Shënime
A new name that clashes with another role ignoring case is 409
role_name_taken.builtindoes not change with the name, which keeps a renamed seeded role in its place inlist.An empty patch is accepted and only moves
updatedAt.Adding a permission the calling key or access token does not hold is 403
insufficient_authority, and none of them holds a console-only one such asaddresses:all. One the role already holds stays only if you send it back, and a console-only one cannot be added back through the API, so send back every entry you read.Retried automatically on network failure and retryable statuses, since the same patch lands on the same row.
E disponueshme edhe në
roles.delete()
Delete a role and move whoever holds it
delete(id: string, options?: RoleDeleteOptions): Promise<DeletedRoleResource>Deletes a role. Every role except Owner can go, seeded ones included, and deleting a seeded role is permanent because seeding never runs twice. The owner role is refused with 409 role_undeletable.
While any member, API key or unanswered invitation still points at the role, the call needs options.reassignTo and is refused with 409 role_in_use without it. The server will not guess, because a key whose role vanished would fall back to no ceiling at all, which is wider than the role being removed. Members, keys and pending invitations move to the named role in one transaction. A role nobody holds deletes without it.
The tombstone reports reassigned people and keysReassigned keys separately. Log the second: those programs keep running under a new ceiling and nobody is told.
Parametrat
idstringE detyrueshmeRole id,
role_followed by 24 hex characters. Roles have no lookup by name.options.reassignTostringId of the role that inherits the members, keys and pending invitations. Required whenever the role is held. Sent as a query parameter.
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
DeletedRoleResource with object set to role, the id, deleted: true, reassigned and keysReassigned.
Shembull
const roles = await openemail.roles.listAll() const viewer = roles.find((role) => role.builtin === 'viewer') const gone = await openemail.roles.delete('role_8b1f4c2e9a7d3b60e5f1a2c4', { reassignTo: viewer?.id}) console.log(gone.reassigned, gone.keysReassigned)Shënime
Naming the owner role in
reassignTois 409role_immutable, naming the role being deleted is 409role_in_use, and an id that names no role on this workspace is 404role_not_foundwithparamset toroleId, whether it was the id being deleted or the one inreassignTo.Revoked API keys still point at their role. A role whose
apiKeyscount is 0 can therefore still needreassignTo, and those keys are included inkeysReassigned.Pending invitations are moved as well but are not counted in the response.
Not retried automatically. A retry after a lost response is a 404, since the role is already gone.
E disponueshme edhe në
roles.listPermissions()
List the permission vocabulary roles are written in
listPermissions(options?: RequestScope): Promise<Array<PermissionResource>>Resolves every permission as a plain array, in the canonical order a stored role's permissions also uses. Each entry carries the label to show beside a checkbox and the group heading it belongs under, so a permission matrix can be rendered from this rather than from a list copied into your code.
scope is the field to branch on. Permissions and API key scopes share one alphabet, which is what lets a role cap a key, but they are not the same set. Six are console-only. addresses:all lets a role reach every address on every domain of the workspace, including ones added later, with no grant, billing:read and billing:write say who may see or change the plan, and workspace:manage who may manage the workspace. api-keys:read and api-keys:write are listed too, but API keys stay with the workspace owner whatever a role holds. No key or access token can ever hold any of the six, so they come back with scope: false. Filter on scope for a key scope picker and ignore it for a role editor.
Parametrat
options.signalAbortSignalCancels the request.
options.apiKeystringOverrides the client API key for this call only.
Kthen
Array<PermissionResource>, each with id, label, group and scope.
Shembull
const permissions = await openemail.roles.listPermissions() const grantableToKeys = permissions.filter((permission) => permission.scope) console.log(grantableToKeys.map((permission) => permission.id))Shënime
groupis one ofaddresses,mail,organising,writing,workspace,peopleordeveloper, withotheras the fallback for a permission not yet placed in a group.The list is the same for every workspace, yet the call still requires
roles:read.