package cs3.identity.group.v1beta1

Get desktop application:
View/edit binary Protocol Buffers messages

Provides an API for managing groups.

• rpc FindGroups (FindGroupsRequest, FindGroupsResponse)

  group_api.proto:65

  Finds groups whose names match the specified filters. MAY return CODE_RESOURCE_EXHAUSTED if the filters return too many responses.

• rpc GetGroup (GetGroupRequest, GetGroupResponse)

  group_api.proto:56

  Gets the information about a group by the group id.

• rpc GetGroupByClaim (GetGroupByClaimRequest, GetGroupByClaimResponse)

  group_api.proto:58

  Gets the information about a group based on a specified claim.

• rpc GetMembers (GetMembersRequest, GetMembersResponse)

  group_api.proto:60

  Gets the members of a group.

• rpc HasMember (HasMemberRequest, HasMemberResponse)

  group_api.proto:62

  Tells if the group has certain member.

Represents a filter to apply to the request.

Used in: FindGroupsRequest

• Filter.Type type = 1

  REQUIRED.

• oneof term

  • GroupType grouptype = 2

  • string query = 3

The filter to apply.

Used in: Filter

• TYPE_INVALID = 0

• TYPE_GROUPTYPE = 1

  extract all groups of a given GroupType

• TYPE_QUERY = 2

  extract all groups matching the given query

Used as request type in: gateway.v1beta1.GatewayAPI.FindGroups, GroupAPI.FindGroups

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• repeated Filter filters = 2

  REQUIRED. The filters to apply.

• bool skip_fetching_members = 3

  OPTIONAL. Whether to skip fetching members along with the group object.

Used as response type in: gateway.v1beta1.GatewayAPI.FindGroups, GroupAPI.FindGroups

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated Group groups = 3

  REQUIRED. The groups matching the specified filter.

Used as request type in: gateway.v1beta1.GatewayAPI.GetGroupByClaim, GroupAPI.GetGroupByClaim

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• string claim = 2

  REQUIRED. The claim on the basis of which groups will be filtered.

• string value = 3

  REQUIRED. The value of the claim to find the specific group.

• bool skip_fetching_members = 4

  OPTIONAL. Whether to skip fetching members along with the group object.

Used as response type in: gateway.v1beta1.GatewayAPI.GetGroupByClaim, GroupAPI.GetGroupByClaim

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional Group group = 3

  REQUIRED. The group information.

Used as request type in: gateway.v1beta1.GatewayAPI.GetGroup, GroupAPI.GetGroup

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional GroupId group_id = 2

  REQUIRED. The id of the group.

• bool skip_fetching_members = 3

  OPTIONAL. Whether to skip fetching members along with the group object.

Used as response type in: gateway.v1beta1.GatewayAPI.GetGroup, GroupAPI.GetGroup

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• optional Group group = 3

  REQUIRED. The group information.

Used as request type in: gateway.v1beta1.GatewayAPI.GetMembers, GroupAPI.GetMembers

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional GroupId group_id = 2

  REQUIRED. The id of the group.

Used as response type in: gateway.v1beta1.GatewayAPI.GetMembers, GroupAPI.GetMembers

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• repeated user.v1beta1.UserId members = 3

  REQUIRED. The members of the group.

Represents a group known by the system.

Used in: admin.group.v1beta1.CreateGroupRequest, admin.group.v1beta1.CreateGroupResponse, FindGroupsResponse, GetGroupByClaimResponse, GetGroupResponse

• optional GroupId id = 1

  REQUIRED. The unique identifier of this group.

• string group_name = 2

  REQUIRED. A human-friendly unique identifier of this group.

• int64 gid_number = 3

  OPTIONAL. The group id of this group in the Unix world.

• string mail = 4

  OPTIONAL. The e-mail address of this group if available.

• bool mail_verified = 5

  OPTIONAL. Whether the e-mail address was verified by the IDP.

• string display_name = 6

  OPTIONAL. A human-friendly display name for this group, e.g. "Foo Group"

• repeated user.v1beta1.UserId members = 7

  OPTIONAL. The list of users that are members of this group.

• optional types.v1beta1.Opaque opaque = 8

  OPTIONAL. Opaque information.

A GroupId represents a group.

Used in: admin.group.v1beta1.AddUserToGroupRequest, admin.group.v1beta1.DeleteGroupRequest, admin.group.v1beta1.RemoveUserFromGroupRequest, GetGroupRequest, GetMembersRequest, Group, HasMemberRequest, permissions.v1beta1.SubjectReference, storage.provider.v1beta1.Grantee

• string idp = 1

  REQUIRED. The identity provider for the group.

• string opaque_id = 2

  REQUIRED. the unique identifier for the group in the scope of the identity provider.

• GroupType type = 3

  OPTIONAL. The type of group.

The type of group.

Used in: Filter, GroupId

• GROUP_TYPE_INVALID = 0

  The group is invalid.

• GROUP_TYPE_REGULAR = 1

  A regular group.

• GROUP_TYPE_FEDERATED = 2

  A federated group provided by external IDPs.

Used as request type in: gateway.v1beta1.GatewayAPI.HasMember, GroupAPI.HasMember

• optional types.v1beta1.Opaque opaque = 1

  OPTIONAL. Opaque information.

• optional GroupId group_id = 2

  REQUIRED. The id of the group.

• optional user.v1beta1.UserId user_id = 3

  REQUIRED. The id of the user to check.

Used as response type in: gateway.v1beta1.GatewayAPI.HasMember, GroupAPI.HasMember

• optional rpc.v1beta1.Status status = 1

  REQUIRED. The response status.

• optional types.v1beta1.Opaque opaque = 2

  OPTIONAL. Opaque information.

• bool ok = 3

  REQUIRED. Tells if the user belongs to the group.