一、成员接口
GET 获取成员列表
GET /v1/members
请求参数
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| page_no | query | integer | 否 | 页码，默认1 |
| page_size | query | integer | 否 | 分页大小，默认10 |
| all | query | boolean | 否 | 是否获取全量数据，当为true时，忽略pageNo和pageSize |
| detail | query | boolean | 否 | 是否需要详情 |
| user | query | string | 否 | 用户名称/ID |
| role_id | query | string | 否 | 成员分组(角色) |
| env_group_id | query | string | 否 | 环境分组 |
| status | query | string | 否 | 状态（DISABLED停用 ENABLED正常） |
| remark | query | string | 否 | 备注 |
| authority | query | string | 否 | 资格（SUPER_ADMIN超管 ADMIN管理员 MANAGER经理 MEMBER员工） |
| start_create_time | query | string | 否 | 开始时间 |
| end_create_time | query | string | 否 | 结束时间 |
| X-API-KEY | header | string | 是 |
返回结果
| 名称 | 类型 | 必选 | 说明 | |
| id | string | 否 | id | |
| create_time | string | 否 | 创建时间 | |
| update_time | string | 否 | 修改时间 | |
| user_id | string | 否 | 用户ID | |
| name | string | 否 | 名称 | |
| string | 否 | 邮箱 | ||
| all_env_group | boolean | 否 | 是否全部分组 | |
| env_group_list | EnvironmentGroupMemberVO | 否 | 环境分组 | |
| role_id | string | 否 | 成员分组ID | |
| role_name | string | 否 | 成员分组名称 | |
| authority | string | 否 | 资格（SUPER_ADMIN超管 ADMIN管理员 MANAGER经理 MEMBER员工） | |
| status | string | 否 | 状态（DISABLED停用 ENABLED启用中） | |
| remark | string | 否 | 备注 | |
| manager_id | string | 否 | 上级经理 | |
| current_user | boolean | 否 | 登录账号是否当前成员 | |
| type | string | 否 | 成员类型 EXTERNAL INTERNAL | |
| login_validate | boolean | 否 | 是否开启登陆验证 | |
| passwd | string | 否 | 成员密码，内部成员 |
EnvironmentGroupMemberVO
| 名称 | 类型 | 必选 | 说明 | |
| group_id | string | 否 | 环境组ID | |
| env_group_name | string | 否 | 环境组名称 | |
| member_id | string | 否 | 成员ID | |
| member_name | string | 否 | 成员名称 |
{
"code": 0,
"msg": "string",
"data": {
"list": [
{
"id": "string",
"create_time": "string",
"update_time": "string",
"user_id": "string",
"name": "string",
"email": "string",
"all_env_group": true,
"env_group_list": [
{
"group_id": null,
"env_group_name": null,
"member_id": null,
"member_name": null
}
],
"role_id": "string",
"role_name": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"manager_id": "string",
"current_user": true,
"type": "EXTERNAL",
"login_validate": true,
"passwd": "string"
}
],
"total": 0
}
}GET 获取成员详情
GET /v1/member/{id}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| id | path | string | 是 | none |
| X-API-KEY | header | string | 是 | none |
返回结果
| 名称 | 类型 | 必选 | 说明 | |
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | OpenMemberVO | 否 | 参考列表 |
{
"code": 0,
"msg": "string",
"data": {
"id": "string",
"create_time": "string",
"update_time": "string",
"user_id": "string",
"name": "string",
"email": "string",
"all_env_group": true,
"env_group_list": [
{
"group_id": "string",
"env_group_name": "string",
"member_id": "string",
"member_name": "string"
}
],
"role_id": "string",
"role_name": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"manager_id": "string",
"current_user": true,
"type": "EXTERNAL",
"login_validate": true,
"passwd": "string"
}
}PUT 修改成员
PUT /v1/member/{id}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| id | path | string | 是 | |
| X-API-KEY | header | string | 是 | |
| body | body | object | 否 | |
| name | body | string | 是 | 名称 |
| body | string | 是 | 邮箱 | |
| phone | body | string | 否 | 手机号 |
| authority | body | string | 是 | 资格（ADMIN管理员 MANAGER经理 MEMBER员工） |
| status | body | string | 否 | 状态（DISABLED停用 ENABLED正常） |
| remark | body | string | 否 | 备注 |
| role_id | body | string | 是 | 成员分组 |
| all_env_group | body | boolean | 否 | 是否全部分组 |
| env_group_ids | body | string | 否 | 环境分组 |
| manager_id | body | string | 否 | 经理id |
| agent_id | body | string | 否 | 代理商ID |
| type | body | string | 否 | 成员类型 |
| passwd | body | string | 否 | 成员密码，内部成员 |
| disuse_enable | body | boolean | 否 | 是否开启到期停用 true:启用 false:关闭 |
| time_zone | body | string | 否 | 时区 |
| disuse_time | body | string | 否 | 过期时间，时间格式（YYYY-MM-dd HH:mm:ss） |
{
"name": "string",
"email": "string",
"phone": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"role_id": "string",
"all_env_group": true,
"env_group_ids": [
"string"
],
"manager_id": "string",
"agent_id": "string",
"type": "EXTERNAL",
"passwd": "string"
}返回结果
{
"code": 0,
"msg": "string",
"data": {}
}DELETE 删除成员
DELETE /v1/member/{id}
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| id | path | string | 是 | none |
| X-API-KEY | header | string | 是 | none |
返回结果
{
"code": 0,
"msg": "string",
"data": {},
"next": "string"
}POST 创建成员
POST /v1/member
{
"name": "string",
"email": "string",
"phone": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"role_id": "string",
"all_env_group": true,
"env_group_ids": [
"string"
],
"manager_id": "string",
"agent_id": "string",
"type": "EXTERNAL",
"passwd": "string"
}请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| X-API-KEY | header | string | 是 | none |
| body | body | object | 否 | none |
| name | body | string | 是 | 名称 |
| body | string | 是 | 邮箱 | |
| phone | body | string | 否 | 手机号 |
| authority | body | string | 是 | 资格（ADMIN管理员 MANAGER经理 MEMBER员工） |
| status | body | string | 否 | 状态（DISABLED停用 ENABLED正常） |
| remark | body | string | 否 | 备注 |
| role_id | body | string | 是 | 成员分组 |
| all_env_group | body | boolean | 否 | 是否全部分组 |
| env_group_ids | body | string | 否 | 环境分组 |
| manager_id | body | string | 否 | 经理id |
| agent_id | body | string | 否 | 代理商ID |
| type | body | string | 否 | 成员类型 |
| passwd | body | string | 否 | 成员密码，内部成员 |
| disuse_enable | body | boolean | 否 | 是否开启到期停用 true:启用 false:关闭 |
| time_zone | body | string | 否 | 时区 |
| disuse_time | body | string | 否 | 过期时间，时间格式（YYYY-MM-dd HH:mm:ss） |
返回结果
{
"code": 0,
"msg": "string",
"data": {
"id": "string",
"create_time": "string",
"update_time": "string",
"user_id": "string",
"name": "string",
"email": "string",
"all_env_group": true,
"env_group_list": [
{
"group_id": "string",
"env_group_name": "string",
"member_id": "string",
"member_name": "string"
}
],
"role_id": "string",
"role_name": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"manager_id": "string",
"current_user": true,
"type": "EXTERNAL",
"login_validate": true,
"passwd": "string"
},
"next": "string"
}| 名称 | 类型 | 必选 | 说明 | |
| code | integer | 否 | ||
| msg | string | 否 | ||
| data | OpenMemberVO | 否 | 参考列表 | |
| next | string | 否 |
GET 获取角色表列表
GET /v1/member/roles
请求参数
| 名称 | 位置 | 类型 | 必选 | 说明 |
| page_no | query | integer | 否 | 页码，默认1 |
| page_size | query | integer | 否 | 分页大小，默认10 |
| all | query | boolean | 否 | 是否获取全量数据，当为true时，忽略pageNo和pageSize |
| detail | query | boolean | 否 | 是否需要详情 |
| name | query | string | 否 | 成员分组名称 |
| member_id | query | string | 否 | 成员Id |
| remark | query | string | 否 | 备注 |
| X-API-KEY | header | string | 是 |
返回结果
{
"code": 0,
"msg": "string",
"data": {
"list": [
{
"id": "string",
"create_time": "string",
"update_time": "string",
"code": "string",
"name": "string",
"status": "DISABLED",
"remark": "string",
"module_ids": [
"string"
],
"member_role_list": [
{
"org_id": null,
"member_id": null,
"member_name": null,
"role_id": null,
"role_name": null,
"code": null
}
],
"current": true
}
],
"total": 0
}
}| 名称 | 类型 | 说明 |
| id | string | id |
| create_time | string | 创建时间 |
| update_time | string | 修改时间 |
| code | string | 角色编码 |
| name | string | 角色名称 |
| status | string | 状态（DISABLED停用 ENABLED正常） |
| remark | string | 备注 |
| module_ids | string | 模块列表 |
| member_role_list | MemberRoleVO | 角色所包含成员 |
| current | boolean | 是否在当前分组 |
MemberRoleVO
| 名称 | 类型 | 必选 | 说明 | |
| org_id | string | 否 | 组织Id | |
| member_id | string | 否 | 成员ID | |
| member_name | string | 否 | 成员名称 | |
| role_id | string | 否 | 角色ID | |
| role_name | string | 否 | 角色名称 | |
| code | string | 否 | 角色code |
PATCH 修改成员
PATCH /v1/member/{id}
请求参数
{
"name": "string",
"email": "string",//必填，如无需修改其他参数，不传则保持不变
"phone": "string",
"authority": "SUPER_ADMIN",
"status": "DISABLED",
"remark": "string",
"role_id": "string",
"all_env_group": true,
"env_group_ids": [
"string"
],
"manager_id": "string",
"agent_id": "string",
"type": "EXTERNAL"
}返回结果
{
"code": 0,
"msg": "string",
"data": {}
}