api/v1/group.proto

DeleteGroupRequest

删除用户组,可以批量删除

Field Type Label Description
id int64 repeated

GetGroupPermissionRequest

获取用户组权限

Field Type Label Description
id int64

GetGroupRequest

根据组名或者ID获取用户组

Field Type Label Description
id int64
title string

Group

用户组,角色

Field Type Label Description
id int64 用户组ID
title string 用户组名称
color string 用户组颜色
is_default bool 是否是默认用户组
is_display bool 是否显示
description string 用户组描述
user_count int32 用户组下的用户数量
sort int32 排序
enable_upload bool 是否允许上传文档
enable_comment_approval bool 是否需要审核评论
created_at google.protobuf.Timestamp 创建时间
updated_at google.protobuf.Timestamp 更新时间

GroupPermissions

用户组权限

Field Type Label Description
permission_id int64 repeated

ListGroupReply

用户组列表

Field Type Label Description
group Group repeated
total int64

ListGroupRequest

查询用户组列表。不需要分页,直接返回全部用户组,只是可以指定查询哪些字段

Field Type Label Description
wd string
page int64
size int64
sort string
field string repeated

UpdateGroupPermissionRequest

更新用户组权限

Field Type Label Description
group_id int64
permission_id int64 repeated

GroupAPI

Method Name Request Type Response Type Description
CreateGroup Group Group 创建用户组
UpdateGroup Group .google.protobuf.Empty 更新用户组
DeleteGroup DeleteGroupRequest .google.protobuf.Empty 删除用户组
GetGroup GetGroupRequest Group 获取用户组
ListGroup ListGroupRequest ListGroupReply 获取用户组列表
GetGroupPermission GetGroupPermissionRequest GroupPermissions 获取用户组权限列表
UpdateGroupPermission UpdateGroupPermissionRequest .google.protobuf.Empty 更新用户组权限,给用户组设置权限

Scalar Value Types

.proto Type Notes C++ Java Python Go C# PHP Ruby
double double double float float64 double float Float
float float float float float32 float float Float
int32 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. int32 int int int32 int integer Bignum or Fixnum (as required)
int64 Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. int64 long int/long int64 long integer/string Bignum
uint32 Uses variable-length encoding. uint32 int int/long uint32 uint integer Bignum or Fixnum (as required)
uint64 Uses variable-length encoding. uint64 long int/long uint64 ulong integer/string Bignum or Fixnum (as required)
sint32 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. int32 int int int32 int integer Bignum or Fixnum (as required)
sint64 Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. int64 long int/long int64 long integer/string Bignum
fixed32 Always four bytes. More efficient than uint32 if values are often greater than 2^28. uint32 int int uint32 uint integer Bignum or Fixnum (as required)
fixed64 Always eight bytes. More efficient than uint64 if values are often greater than 2^56. uint64 long int/long uint64 ulong integer/string Bignum
sfixed32 Always four bytes. int32 int int int32 int integer Bignum or Fixnum (as required)
sfixed64 Always eight bytes. int64 long int/long int64 long integer/string Bignum
bool bool boolean boolean bool bool boolean TrueClass/FalseClass
string A string must always contain UTF-8 encoded or 7-bit ASCII text. string String str/unicode string string string String (UTF-8)
bytes May contain any arbitrary sequence of bytes. string ByteString str []byte ByteString string String (ASCII-8BIT)