package api.v1.group
Get desktop application:
View/edit binary Protocol Buffers messages
service Service
service.proto:10The service to manage groups in Users.
rpc Create (, )
service.proto:12Create a new group.
message
service.proto:33The request of a Groups.Create RPC.
repeated initializers = 1
The group to create.
message
service.proto:39The response of a Groups.Create RPC.
optional group = 1
The created group.
rpc Delete (, )
service.proto:14Delete a group.
message
service.proto:61The request of a Group.Delete RPC.
string group_id = 1
The group to delete.
message
service.proto:67The response of a Group.Delete RPC.
(message has no fields)
rpc List (, )
service.proto:16List groups.
message
service.proto:45The request of a Groups.List RPC.
optional pagination = 1
Pagination options.
string search = 2
Search string.
message
service.proto:53The response of a Groups.List RPC.
repeated groups = 1
list of groups.
uint64 total = 2
total amount of groups.
rpc Update (, )
service.proto:18Update group.
message
service.proto:70The request of a Groups.Update RPC.
repeated updates = 1
The updates to apply.
string group_id = 2
The group id.
message
service.proto:78The response of a Groups.Update RPC.
(message has no fields)
rpc Get (, )
service.proto:20Get group.
message
service.proto:81The request of a Groups.Get RPC.
string group_id = 1
The group id.
message
service.proto:87The response of a Groups.Get RPC
optional group = 1
The group.
rpc AddMember (, )
service.proto:22Add a member to a group.
message
service.proto:93Request for adding one or more members to a group.
string group_id = 1
The group to add members to.
repeated member_ids = 2
The members to add.
message
service.proto:101Empty response for adding one or more members to a group.
(message has no fields)
rpc RemoveMember (, )
service.proto:24Remove member from group.
message
service.proto:104Request for removing a member from a group.
string group_id = 1
The group to remove the member from.
optional member_id = 2
The member to remove.
message
service.proto:112Empty response for removing a member from a group.
(message has no fields)
rpc ListMembers (, )
service.proto:26Get Group Members.
message
service.proto:115Reqyest for listing members of a group.
string group_id = 1
The group to list members of.
optional pagination = 2
Pagination options.
message
service.proto:123Response for listing members of a group.
repeated members = 1
The members in the group.
uint64 total = 2
The total amount of members in the group.
rpc ListGroupsForMember (, )
service.proto:28Get Groups.
message
service.proto:131Request for listing the groups a member is in.
optional member_id = 1
The member to list groups for.
optional pagination = 2
Pagination options.
message
service.proto:139Response for listing the groups a member is in.
repeated groups = 1
The groups the member is in.
uint64 total = 2
The total amount of groups the member is in.
message
group.proto:10Group is a named collection of users and service accounts with optional metadata.
Used in: , , ,
string group_id = 1
Unique name of the group.
uint64 num_members = 5
Number of members.
map<string, bytes> metadata = 6
Metadata of the group.
optional created_at = 7
Creation time of the group.
optional updated_at = 8
Last update time of the group.
message
group.proto:36MemberID is a union of service account id and user id.
Used in: , ,
oneof kind
string service_account_id = 1
ID of a service account.
string user_id = 2
ID of a user.
message
group.proto:24An update msg for a group.
Used in: ,
oneof field
string group_id = 1
Update the unique group name.
set_metadata = 2
Update or create a metadata entry.
string delete_metadata_key = 3
Delete a metadata entry.