package api.v1.role
Get desktop application:
View/edit binary Protocol Buffers messages
service Service
service.proto:9Service to manage roles that controls the RBAC.
rpc Create (, )
service.proto:11Create a new role.
message
service.proto:55Request to create a role.
string role_id = 1
The id / name of the role to create.
repeated permissions = 2
The permissions to assign to the role.
message
service.proto:63Response to create a role.
optional role = 1
The created role.
rpc Delete (, )
service.proto:13Delete role.
message
service.proto:69Request to delete a role.
string role_id = 1
The id / name of the role to delete.
message
service.proto:75Empty Response to delete a role.
(message has no fields)
rpc List (, )
service.proto:15List roles.
message
service.proto:78Request to list roles.
optional pagination = 1
Pagination options.
message
service.proto:84Response to list roles.
repeated roles = 1
The retrieved roles.
rpc Update (, )
service.proto:17Update role
message
service.proto:90Request to update a role.
string role_id = 1
the role to update.
repeated updates = 2
The updates to apply to the role.
message
service.proto:98Empty update response.
(message has no fields)
rpc Get (, )
service.proto:19Get role.
message
service.proto:101Request to retrieve a role.
string role_id = 1
The role to retrieve.
message
service.proto:107Response to getting a role.
optional role = 1
The retrieved role.
rpc Assign (, )
service.proto:21Assign a role.
message
service.proto:113Assign a role to an entity.
string role_id = 1
The role to assign.
optional entity_id = 2
The entity to assign the role to.
message
service.proto:121Empty response of assigning a role to an entity.
(message has no fields)
rpc Revoke (, )
service.proto:23Revoke a role.
message
service.proto:124Revoke a role from an entity.
string role_id = 1
The role to revoke.
optional entity_id = 2
The entity to revoke the role from.
message
service.proto:132Empty response for revoking a role.
(message has no fields)
rpc ListForEntity (, )
service.proto:25List roles for an entity.
message
service.proto:42optional entity_id = 1
The entity to list roles for.
optional pagination = 2
Pagination options.
message
service.proto:49repeated string role_ids = 1
The roles assigned to the entity.
rpc ListAssignees (, )
service.proto:27List Assignees.
message
service.proto:30string role_id = 1
The role to list assignees for.
optional pagination = 2
Pagination options.
message
service.proto:37repeated string entity_ids = 1
The assignees of the role.
message
role.proto:24EntityID is a oneof type that can be used to represent a user, service account or group.
Used in: , ,
oneof kind
The type of entity that has a role.
string user_id = 1
User entity.
string service_account_id = 2
Service account entity.
string group_id = 3
Group entity.
message
role.proto:37A permission that is granted to a role.
Used in: , ,
string action = 1
The action that is action permission to perform.
optional scope = 2
The scope in which the action can be performed.
message
role.proto:9Role model for Role based access control.
Used in: , ,
string role_id = 1
Unique ID of the role.
repeated permissions = 2
The permissions granted to the role.
map<string, bytes> metadata = 3
Metadata associated with the role.
optional created_at = 4
Timestamp when the role was created.
optional updated_at = 5
Timestamp when the role was last updated.
message
role.proto:45Scope for permissions.
Used in:
string resource = 1
The resource on which the action can be performed. This consists of a type, and an optional ID. fx. "user/*", "group/admin"
string environment = 2
The environment in which the action can be performed. This can be a wildcard.
string project = 3
The project in which the action can be performed. This can be a wildcard.
message
role.proto:57Update message to update a field of a role.
Used in:
oneof update
add_permission = 1
Adding a permission to the role.
remove_permission = 2
Removing a permission from the role.
set_metadata = 3
Update or create a metadata field on the role.
string delete_metadata_key = 4
Delete a metadata field on the role.