package cs3.admin.group.v1beta1
Get desktop application:
View/edit binary Protocol Buffers messages
service GroupAPI
group_api.proto:37Provides a write only API for managing groups.
rpc AddUserToGroup (, )
group_api.proto:43Add a user to a group.
message
group_api.proto:87optional user_id = 1
REQUIRED. ID of the user to add to the group
optional group_id = 2
REQUIRED. ID of the target group.
optional opaque = 3
OPTIONAL. Opaque information.
message
group_api.proto:99optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
rpc CreateGroup (, )
group_api.proto:39Create a group.
message
group_api.proto:48optional opaque = 1
OPTIONAL. Opaque information. Allow to send any arbitrary data a service might use that is outside the API boundaries
optional group = 2
REQUIRED. The information of group to be created.
message
group_api.proto:57optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
optional group = 3
REQUIRED. The group information.
rpc DeleteGroup (, )
group_api.proto:41Delete a group.
message
group_api.proto:69optional opaque = 1
OPTIONAL. Opaque information. Allow to send any arbitrary data a service might use that is outside the API boundaries.
optional group_id = 2
REQUIRED. The group to be deleted, given their ID.
message
group_api.proto:78optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.
Remove a user from a group.
message
group_api.proto:108optional user_id = 1
REQUIRED. ID of the user to add to the group
optional group_id = 2
REQUIRED. ID of the target group.
optional opaque = 3
OPTIONAL. Opaque information.
message
group_api.proto:120optional status = 1
REQUIRED. The response status.
optional opaque = 2
OPTIONAL. Opaque information.