client.Roles
Cada método de este espacio de nombres: su firma, sus parámetros, lo que devuelve y un ejemplo.
Métodos
What a member or an API key may do, drawn from one permission vocabulary.
Roles.List
List every role in the workspace
List(ctx context.Context, opts ...openemail.RequestOption) (*openemail.Page, error)Returns 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.
Parámetros
openemail.WithLimitintPage size, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringThe
NextCursorof the previous page. Leave it out for the first page.openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
A *openemail.Page with Items, HasMore and NextCursor. Each item has id, name, description, permissions, builtin, editable, deletable, members, apiKeys, createdAt and updatedAt.
Ejemplo
page, err := client.Roles.List(ctx)if err != nil { return err} for _, role := range page.Items { fmt.Println(role.String("id"), role.String("name"))} fmt.Println(page.HasMore, page.NextCursor)Notas
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.
También disponible en
- API
GET /roles- TypeScript
roles.list()- Python
roles.list()- Ruby
roles.list- PHP
roles->list- Java
roles().list- C#
Roles.ListAsync- CLI
openemail roles list
Roles.ListAll
Collect every role into one slice
ListAll(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)Walks every page of List and returns with all roles, seeded roles first in ladder order, then custom roles alphabetically. One request per page.
Parámetros
openemail.WithLimitintPage size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringStarts the walk after this cursor instead of the first page.
openemail.WithAPIKeystringOverrides the client API key for every page of this walk.
Devuelve
A []openemail.Object holding every role.
Ejemplo
all, err := client.Roles.ListAll(ctx, openemail.WithLimit(100))if err != nil { return err} for _, role := range all { fmt.Println(role.String("id"), role.String("name"))}Notas
If any page fails the call fails and the roles already fetched are discarded.
También disponible en
- API
GET /roles- TypeScript
roles.listAll()- Python
roles.list_all()- Ruby
roles.list_all- PHP
roles->listAll- Java
roles().listAll- C#
Roles.ListAllAsync
Roles.Iterate
Stream the roles one at a time
Iterate(ctx context.Context, opts ...openemail.RequestOption) *openemail.IteratorReturns an iterator 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.
Parámetros
openemail.WithLimitintPage size for each request, from 1 to 100. The server defaults to 25.
openemail.WithCursorstringStarts the walk after this cursor instead of the first page.
openemail.WithAPIKeystringOverrides the client API key for every page of this walk.
Devuelve
An *openemail.Iterator yielding one role per step.
Ejemplo
for role, err := range client.Roles.Iterate(ctx).All() { if err != nil { return err } fmt.Println(role.String("id"), role.String("name"))}Notas
The iterator is lazy, so an abandoned loop costs only the pages you consumed.
También disponible en
- API
GET /roles- TypeScript
roles.iterate()- Python
roles.iterate()- Ruby
roles.iterate- PHP
roles->iterate- Java
roles().iterate- C#
Roles.IterateAsync
Roles.Get
Read one role with its usage counts
Get(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)Returns 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.
Parámetros
idstringObligatorioRole id,
role_followed by 24 hex characters. Roles have no lookup by name.openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
An openemail.Object with permissions, builtin, the editable and deletable flags, and live members and apiKeys counts.
Ejemplo
role, err := client.Roles.Get(ctx, "role_8b1f4c2e9a7d3b60e5f1a2c4")if err != nil { return err} fmt.Println(role.String("name"), role.Int("members"), role.Int("apiKeys"))Notas
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.
También disponible en
- API
GET /roles/{id}- TypeScript
roles.get()- Python
roles.get()- Ruby
roles.get- PHP
roles->get- Java
roles().get- C#
Roles.GetAsync- CLI
openemail roles get
Roles.Create
Create a custom role
Create(ctx context.Context, body openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)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.
Parámetros
namestringObligatorioAt most 48 characters after trimming, unique per workspace ignoring case. Blank is a 422.
permissions[]openemail.BodyObligatorioWhat the role grants, drawn from
ListPermissions. 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 null.
openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
An openemail.Object with the expanded permissions, builtin: null, editable and deletable true, and members and apiKeys at 0.
Ejemplo
support, err := client.Roles.Create(ctx, openemail.Body{ "name": "Support", "description": "Answers help@ and nothing else.", "permissions": []string{"threads:write", "emails:send", "templates:read"},})if err != nil { return err} fmt.Println(support.String("id"))Notas
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.
También disponible en
- API
POST /roles- TypeScript
roles.create()- Python
roles.create()- Ruby
roles.create- PHP
roles->create- Java
roles().create- C#
Roles.CreateAsync- CLI
openemail roles create
Roles.Update
Rename a role or replace what it grants
Update(ctx context.Context, id string, patch openemail.Body, opts ...openemail.RequestOption) (openemail.Object, error)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.
Parámetros
idstringObligatorioRole 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 | nilNew note of at most 240 characters. Null or blank clears it.
permissions[]openemail.BodyComplete replacement list, expanded with implied permissions before it is stored.
openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
An openemail.Object as saved, with live members and apiKeys counts.
Ejemplo
role, err := client.Roles.Get(ctx, "role_8b1f4c2e9a7d3b60e5f1a2c4")if err != nil { return err} updated, err := client.Roles.Update(ctx, role.ID(), openemail.Body{ "name": "Finance", "permissions": append(role.Strings("permissions"), "domains:read"),})if err != nil { return err} fmt.Println(updated.String("name"), updated.Strings("permissions"))Notas
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.
También disponible en
- API
PATCH /roles/{id}- TypeScript
roles.update()- Python
roles.update()- Ruby
roles.update- PHP
roles->update- Java
roles().update- C#
Roles.UpdateAsync- CLI
openemail roles update
Roles.Delete
Delete a role and move whoever holds it
Delete(ctx context.Context, id string, opts ...openemail.RequestOption) (openemail.Object, error)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 openemail.WithReassignTo 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.
Parámetros
idstringObligatorioRole id,
role_followed by 24 hex characters. Roles have no lookup by name.openemail.WithReassignTostringId of the role that inherits the members, keys and pending invitations. Required whenever the role is held. Sent as a query parameter.
openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
An openemail.Object with object set to role, the id, deleted: true, reassigned and keysReassigned.
Ejemplo
gone, err := client.Roles.Delete(ctx, "role_8b1f4c2e9a7d3b60e5f1a2c4", openemail.WithReassignTo("role_2c4e6a8b0d1f3a5c7e9b1d3f"))if err != nil { return err} fmt.Println(gone.Int("reassigned"), gone.Int("keysReassigned"))Notas
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.
También disponible en
- API
DELETE /roles/{id}- TypeScript
roles.delete()- Python
roles.delete()- Ruby
roles.delete- PHP
roles->delete- Java
roles().delete- C#
Roles.DeleteAsync- CLI
openemail roles delete
Roles.ListPermissions
List the permission vocabulary roles are written in
ListPermissions(ctx context.Context, opts ...openemail.RequestOption) ([]openemail.Object, error)Returns every permission as a plain slice, 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.
Parámetros
openemail.WithAPIKeystringOverrides the client API key for this call only.
Devuelve
A []openemail.Object, each with id, label, group and scope.
Ejemplo
permissions, err := client.Roles.ListPermissions(ctx)if err != nil { return err} for _, permission := range permissions { fmt.Println(permission.Bool("scope"), permission.String("id"))}Notas
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.