diff --git a/cs3/gateway/v1beta1/gateway_api.proto b/cs3/gateway/v1beta1/gateway_api.proto index 02ef4a9e..6c3a6403 100644 --- a/cs3/gateway/v1beta1/gateway_api.proto +++ b/cs3/gateway/v1beta1/gateway_api.proto @@ -275,8 +275,6 @@ service GatewayAPI { rpc GetUserByClaim(cs3.identity.user.v1beta1.GetUserByClaimRequest) returns (cs3.identity.user.v1beta1.GetUserByClaimResponse); // Gets the groups of a user. rpc GetUserGroups(cs3.identity.user.v1beta1.GetUserGroupsRequest) returns (cs3.identity.user.v1beta1.GetUserGroupsResponse); - // Tells if the user is in a certain group. - rpc IsInGroup(cs3.identity.user.v1beta1.IsInGroupRequest) returns (cs3.identity.user.v1beta1.IsInGroupResponse); // Finds users by any attribute of the user. // TODO(labkode): to define the filters that make more sense. rpc FindUsers(cs3.identity.user.v1beta1.FindUsersRequest) returns (cs3.identity.user.v1beta1.FindUsersResponse); diff --git a/cs3/identity/group/v1beta1/group_api.proto b/cs3/identity/group/v1beta1/group_api.proto index 5922a390..fa9d8c2f 100644 --- a/cs3/identity/group/v1beta1/group_api.proto +++ b/cs3/identity/group/v1beta1/group_api.proto @@ -33,10 +33,10 @@ import "cs3/identity/user/v1beta1/resources.proto"; import "cs3/rpc/v1beta1/status.proto"; import "cs3/types/v1beta1/types.proto"; -// UserProvider API. +// GroupProvider API. // -// The UserProvider API is responsible for creating -// a key-value map according to group groupprovider. +// The GroupProvider API is responsible for providing methods to retrieve +// information about groups and their interactions with users. // // The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL // NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and @@ -44,7 +44,7 @@ import "cs3/types/v1beta1/types.proto"; // RFC 2119. // // The following are global requirements that apply to all methods: -// Any method MUST return CODE_OK on a succesful operation. +// Any method MUST return CODE_OK on a successful operation. // Any method MAY return NOT_IMPLEMENTED. // Any method MAY return INTERNAL. // Any method MAY return UNKNOWN. diff --git a/cs3/identity/user/v1beta1/user_api.proto b/cs3/identity/user/v1beta1/user_api.proto index 7a861b84..d79f8369 100644 --- a/cs3/identity/user/v1beta1/user_api.proto +++ b/cs3/identity/user/v1beta1/user_api.proto @@ -28,15 +28,14 @@ option java_package = "com.cs3.identity.user.v1beta1"; option objc_class_prefix = "CIU"; option php_namespace = "Cs3\\Identity\\User\\V1Beta1"; -import "cs3/identity/group/v1beta1/resources.proto"; import "cs3/identity/user/v1beta1/resources.proto"; import "cs3/rpc/v1beta1/status.proto"; import "cs3/types/v1beta1/types.proto"; // UserProvider API. // -// The UserProvider API is responsible for creating -// a key-value map according to user userprovider. +// The UserProvider API is responsible for providing +// methods to retrieve information about the users. // // The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL // NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and @@ -44,7 +43,7 @@ import "cs3/types/v1beta1/types.proto"; // RFC 2119. // // The following are global requirements that apply to all methods: -// Any method MUST return CODE_OK on a succesful operation. +// Any method MUST return CODE_OK on a successful operation. // Any method MAY return NOT_IMPLEMENTED. // Any method MAY return INTERNAL. // Any method MAY return UNKNOWN. @@ -58,8 +57,6 @@ service UserAPI { rpc GetUserByClaim(GetUserByClaimRequest) returns (GetUserByClaimResponse); // Gets the groups of a user. rpc GetUserGroups(GetUserGroupsRequest) returns (GetUserGroupsResponse); - // Tells if the user is in a certain group. - rpc IsInGroup(IsInGroupRequest) returns (IsInGroupResponse); // Finds users by any attribute of the user. // TODO(labkode): to define the filters that make more sense. rpc FindUsers(FindUsersRequest) returns (FindUsersResponse); @@ -131,30 +128,6 @@ message GetUserGroupsResponse { repeated string groups = 3; } -message IsInGroupRequest { - // OPTIONAL. - // Opaque information. - cs3.types.v1beta1.Opaque opaque = 1; - // REQUIRED. - // The id of the user. - cs3.identity.user.v1beta1.UserId user_id = 2; - // REQUIRED. - // The id of the group to check. - cs3.identity.group.v1beta1.GroupId group_id = 3; -} - -message IsInGroupResponse { - // REQUIRED. - // The response status. - cs3.rpc.v1beta1.Status status = 1; - // OPTIONAL. - // Opaque information. - cs3.types.v1beta1.Opaque opaque = 2; - // REQUIRED. - // Tells if the user belongs to the group. - bool ok = 3; -} - message FindUsersRequest { // OPTIONAL. // Opaque information. diff --git a/docs/index.html b/docs/index.html index ea6d6869..6cefdc13 100644 --- a/docs/index.html +++ b/docs/index.html @@ -681,14 +681,6 @@
Gets the groups of a user.
Tells if the user is in a certain group.
Field | Type | Label | Description |
opaque | -cs3.types.v1beta1.Opaque | -- | OPTIONAL. -Opaque information. |
-
user_id | -UserId | -- | REQUIRED. -The id of the user. |
-
group_id | -cs3.identity.group.v1beta1.GroupId | -- | REQUIRED. -The id of the group to check. |
-
Field | Type | Label | Description |
status | -cs3.rpc.v1beta1.Status | -- | REQUIRED. -The response status. |
-
opaque | -cs3.types.v1beta1.Opaque | -- | OPTIONAL. -Opaque information. |
-
ok | -bool | -- | REQUIRED. -Tells if the user belongs to the group. |
-
Gets the groups of a user.
Tells if the user is in a certain group.