client.roles
Каждый метод этого пространства имён: его сигнатура, параметры, что он возвращает, и пример.
Методы
What a member or an API key may do, drawn from one permission vocabulary.
roles.list
List every role in the workspace
list(limit: nil, cursor: nil, api_key: nil) -> OpenEmail::PageReturns one page of the roles the workspace defines. list_all 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.
Параметры
limitIntegerPage size, from 1 to 100. The server defaults to 25.
cursorStringThe
next_cursorof the previous page. Leave it out for the first page.api_keyStringOverrides the client API key for this call only.
Возвращает
An OpenEmail::Page of Hashes, with items, has_more? and next_cursor. Each item has id, name, description, permissions, builtin, editable, deletable, members, apiKeys, createdAt and updatedAt.
Пример
roles = client.roles.list_all custom = roles.select { |role| role[:builtin].nil? } p roles.map { |role| [role[:name], role[:members], role[:apiKeys]] }puts custom.sizeПримечания
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.
Также доступно в
- API
GET /roles- TypeScript
roles.list()- Python
roles.list()- CLI
openemail roles list
roles.list_all
Collect every role into one array
list_all(limit: nil, cursor: nil, api_key: nil) -> Array<Hash>Walks every page of list and returns all roles in one Array, seeded roles first in ladder order, then custom roles alphabetically. One request per page.
Параметры
limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Возвращает
An Array of Hashes holding every role, each with the fields list returns.
Пример
all = client.roles.list_all(limit: 100) puts all.sizeПримечания
If any page fails, the error is raised and the roles already fetched are discarded.
Также доступно в
- API
GET /roles- TypeScript
roles.listAll()- Python
roles.list_all()
roles.iterate
Stream the roles one at a time
iterate(limit: nil, cursor: nil, api_key: nil, &block) -> Enumerator<Hash>Returns an Enumerator 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. Given a block, it yields each role to the block instead.
Параметры
limitIntegerPage size for each request, from 1 to 100. The server defaults to 25.
cursorStringStarts the walk after this cursor instead of the first page.
api_keyStringOverrides the client API key for every page of this walk.
Возвращает
An Enumerator of Hashes, one role per step (or yields each one to a block).
Пример
client.roles.iterate do |item| p itemendПримечания
Pages are fetched only as they are needed, so an abandoned loop costs only the pages you consumed.
Также доступно в
- API
GET /roles- TypeScript
roles.iterate()- Python
roles.iterate()
roles.get
Read one role with its usage counts
get(id, api_key: nil) -> HashReturns 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.
Параметры
idStringОбязательноRole id,
role_followed by 24 hex characters. Roles have no lookup by name.api_keyStringOverrides the client API key for this call only.
Возвращает
A Hash with permissions, builtin, the editable and deletable flags, and live members and apiKeys counts.
Пример
role = client.roles.get("role_8b1f4c2e9a7d3b60e5f1a2c4") puts role[:name]p role[:permissions]puts role[:members], role[:apiKeys]Примечания
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.
Также доступно в
- API
GET /roles/{id}- TypeScript
roles.get()- Python
roles.get()- CLI
openemail roles get
roles.create
Create a custom role
create(body = nil, api_key: nil, **fields) -> HashWrites a role the workspace defines for itself. builtin comes back nil 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.
Параметры
nameStringОбязательноAt most 48 characters after trimming, unique per workspace ignoring case. Blank is a 422.
permissionsArray<String>ОбязательноWhat the role grants, drawn from
list_permissions. An empty array is accepted and makes a role that can do nothing.descriptionStringOne sentence about who the role is for, at most 240 characters. Blank is stored as nil.
api_keyStringOverrides the client API key for this call only.
Возвращает
A Hash for the role with the expanded permissions, builtin nil, editable and deletable true, and members and apiKeys at 0.
Пример
support = client.roles.create( name: "Support", description: "Answers help@ and nothing else.", permissions: ["threads:write", "emails:send", "templates:read"]) puts support[:id]p support[:permissions]Примечания
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 oneslist_permissionsmarks 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.
Также доступно в
- API
POST /roles- TypeScript
roles.create()- Python
roles.create()- CLI
openemail roles create
roles.update
Rename a role or replace what it grants
update(id, patch = nil, api_key: nil, **fields) -> HashPatches 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: nil 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.
Параметры
idStringОбязательноRole id,
role_followed by 24 hex characters. Roles have no lookup by name.nameStringNew name, at most 48 characters after trimming and unique per workspace ignoring case. Blank is a 422.
descriptionString or nilNew note of at most 240 characters. A nil or blank value clears it.
permissionsArray<String>Complete replacement list, expanded with implied permissions before it is stored.
api_keyStringOverrides the client API key for this call only.
Возвращает
A Hash for the role as saved, with live members and apiKeys counts.
Пример
role = client.roles.get("role_8b1f4c2e9a7d3b60e5f1a2c4") updated = client.roles.update(role[:id], name: "Finance", permissions: [*role[:permissions], "domains:read"]) puts updated[:name]p updated[:permissions]Примечания
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.
Также доступно в
- API
PATCH /roles/{id}- TypeScript
roles.update()- Python
roles.update()- CLI
openemail roles update
roles.delete
Delete a role and move whoever holds it
delete(id, reassign_to: nil, api_key: nil) -> HashDeletes 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 reassign_to: 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.
Параметры
idStringОбязательноRole id,
role_followed by 24 hex characters. Roles have no lookup by name.reassign_toStringId of the role that inherits the members, keys and pending invitations. Required whenever the role is held. Sent as a query parameter.
api_keyStringOverrides the client API key for this call only.
Возвращает
A Hash with object set to role, the id, deleted set to true, reassigned and keysReassigned.
Пример
roles = client.roles.list_all viewer = roles.find { |role| role[:builtin] == "viewer" } gone = client.roles.delete("role_8b1f4c2e9a7d3b60e5f1a2c4", reassign_to: viewer&.fetch(:id)) puts gone[:reassigned], gone[:keysReassigned]Примечания
Naming the owner role in
reassign_to:is 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 inreassign_to:.Revoked API keys still point at their role. A role whose
apiKeyscount is 0 can therefore still needreassign_to:, 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.
Также доступно в
- API
DELETE /roles/{id}- TypeScript
roles.delete()- Python
roles.delete()- CLI
openemail roles delete
roles.list_permissions
List the permission vocabulary roles are written in
list_permissions(api_key: nil) -> Array<Hash>Returns 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. Four are console-only. addresses:all lets a role reach every address on every domain of the workspace, including ones added later, with no grant, and workspace:manage says 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 four, so they come back with scope: false. billing:read and billing:write say who may see or change the plan, and they are API scopes as well, so they come back with scope: true. Filter on scope for a key scope picker and ignore it for a role editor.
Параметры
api_keyStringOverrides the client API key for this call only.
Возвращает
An Array of Hashes, each with id, label, group and scope.
Пример
permissions = client.roles.list_permissions grantable_to_keys = permissions.select { |permission| permission[:scope] } p grantable_to_keys.map { |permission| permission[:id] }Примечания
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.