# Protocol Documentation
< a name = "top" > < / a >
## Table of Contents
- [api/v1/group.proto ](#api_v1_group-proto )
- [DeleteGroupRequest ](#api-v1-DeleteGroupRequest )
- [GetGroupPermissionRequest ](#api-v1-GetGroupPermissionRequest )
- [GetGroupRequest ](#api-v1-GetGroupRequest )
- [Group ](#api-v1-Group )
- [GroupPermissions ](#api-v1-GroupPermissions )
- [ListGroupReply ](#api-v1-ListGroupReply )
- [ListGroupRequest ](#api-v1-ListGroupRequest )
- [UpdateGroupPermissionRequest ](#api-v1-UpdateGroupPermissionRequest )
- [GroupAPI ](#api-v1-GroupAPI )
- [Scalar Value Types ](#scalar-value-types )
< a name = "api_v1_group-proto" > < / a >
< p align = "right" > < a href = "#top" > Top< / a > < / p >
## api/v1/group.proto
< a name = "api-v1-DeleteGroupRequest" > < / a >
### DeleteGroupRequest
删除用户组，可以批量删除
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int64 ](#int64 ) | repeated | |
< a name = "api-v1-GetGroupPermissionRequest" > < / a >
### GetGroupPermissionRequest
获取用户组权限
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int64 ](#int64 ) | | |
< a name = "api-v1-GetGroupRequest" > < / a >
### GetGroupRequest
根据组名或者ID获取用户组
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int64 ](#int64 ) | | |
| title | [string ](#string ) | | |
< a name = "api-v1-Group" > < / a >
### Group
用户组，角色
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| id | [int64 ](#int64 ) | | 用户组ID |
| title | [string ](#string ) | | 用户组名称 |
| color | [string ](#string ) | | 用户组颜色 |
| is_default | [bool ](#bool ) | | 是否是默认用户组 |
| is_display | [bool ](#bool ) | | 是否显示 |
| description | [string ](#string ) | | 用户组描述 |
| user_count | [int32 ](#int32 ) | | 用户组下的用户数量 |
| sort | [int32 ](#int32 ) | | 排序 |
| enable_upload | [bool ](#bool ) | | 是否允许上传文档 |
| enable_comment_approval | [bool ](#bool ) | | 是否需要审核评论 |
| created_at | [google.protobuf.Timestamp ](#google-protobuf-Timestamp ) | | 创建时间 |
| updated_at | [google.protobuf.Timestamp ](#google-protobuf-Timestamp ) | | 更新时间 |
< a name = "api-v1-GroupPermissions" > < / a >
### GroupPermissions
用户组权限
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| permission_id | [int64 ](#int64 ) | repeated | |
< a name = "api-v1-ListGroupReply" > < / a >
### ListGroupReply
用户组列表
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| group | [Group ](#api-v1-Group ) | repeated | |
| total | [int64 ](#int64 ) | | |
< a name = "api-v1-ListGroupRequest" > < / a >
### ListGroupRequest
查询用户组列表。不需要分页，直接返回全部用户组，只是可以指定查询哪些字段
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| wd | [string ](#string ) | | |
| page | [int64 ](#int64 ) | | |
| size | [int64 ](#int64 ) | | |
| sort | [string ](#string ) | | |
| field | [string ](#string ) | repeated | |
< a name = "api-v1-UpdateGroupPermissionRequest" > < / a >
### UpdateGroupPermissionRequest
更新用户组权限
| Field | Type | Label | Description |
| ----- | ---- | ----- | ----------- |
| group_id | [int64 ](#int64 ) | | |
| permission_id | [int64 ](#int64 ) | repeated | |
< a name = "api-v1-GroupAPI" > < / a >
### GroupAPI
| Method Name | Request Type | Response Type | Description |
| ----------- | ------------ | ------------- | ------------|
| CreateGroup | [Group ](#api-v1-Group ) | [Group ](#api-v1-Group ) | 创建用户组 |
| UpdateGroup | [Group ](#api-v1-Group ) | [.google.protobuf.Empty ](#google-protobuf-Empty ) | 更新用户组 |
| DeleteGroup | [DeleteGroupRequest ](#api-v1-DeleteGroupRequest ) | [.google.protobuf.Empty ](#google-protobuf-Empty ) | 删除用户组 |
| GetGroup | [GetGroupRequest ](#api-v1-GetGroupRequest ) | [Group ](#api-v1-Group ) | 获取用户组 |
| ListGroup | [ListGroupRequest ](#api-v1-ListGroupRequest ) | [ListGroupReply ](#api-v1-ListGroupReply ) | 获取用户组列表 |
| GetGroupPermission | [GetGroupPermissionRequest ](#api-v1-GetGroupPermissionRequest ) | [GroupPermissions ](#api-v1-GroupPermissions ) | 获取用户组权限列表 |
| UpdateGroupPermission | [UpdateGroupPermissionRequest ](#api-v1-UpdateGroupPermissionRequest ) | [.google.protobuf.Empty ](#google-protobuf-Empty ) | 更新用户组权限，给用户组设置权限 |
## Scalar Value Types
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| ----------- | ----- | --- | ---- | ------ | -- | -- | --- | ---- |
| < a name = "double" / > double | | double | double | float | float64 | double | float | Float |
| < a name = "float" / > float | | float | float | float | float32 | float | float | Float |
| < a name = "int32" / > int32 | Uses variable-length encoding. Inefficient for encoding negative numbers –
| < a name = "int64" / > int64 | Uses variable-length encoding. Inefficient for encoding negative numbers –
| < a name = "uint32" / > uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| < a name = "uint64" / > uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| < a name = "sint32" / > 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) |
| < a name = "sint64" / > 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 |
| < a name = "fixed32" / > 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) |
| < a name = "fixed64" / > 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 |
| < a name = "sfixed32" / > sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| < a name = "sfixed64" / > sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| < a name = "bool" / > bool | | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass |
| < a name = "string" / > string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| < a name = "bytes" / > bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |
