Local API V2 – 成员与权限接口

查询成员列表

接口地址

GET /openapi/v2/members

用于查询团队成员列表。

查询参数

名称	类型	必填	说明
request	string	是	成员列表查询参数。

响应参数

data.list 为成员列表，成员字段见 成员字段。

创建成员

接口地址

POST /openapi/v2/members

用于创建团队成员。

请求参数

请求体字段见 成员创建和更新参数。

请求示例

  -d '{
    "name": "automation member",
    "account": "automation@example.com",
    "authority": "staff",
    "status": "enabled",
    "all_profile_groups": false,
    "profile_group_ids": [],
    "type": "internal",
    "password": "password"
  }'

获取成员详情

接口地址

GET /openapi/v2/members/{memberId}

用于获取成员详情。

路径参数

名称	类型	必填	说明
memberId	string	是	成员 ID。

修改成员

接口地址

PATCH /openapi/v2/members/{memberId}

用于修改成员信息。

路径参数

名称	类型	必填	说明
memberId	string	是	成员 ID。

请求参数

请求体字段见 成员创建和更新参数。未传入的字段保持不变。

删除成员

接口地址

DELETE /openapi/v2/members/{memberId}

用于删除成员。删除前请确认该成员不再需要继续访问当前团队。

路径参数

名称	类型	必填	说明
memberId	string	是	成员 ID。

修改成员可访问环境分组

接口地址

PATCH /openapi/v2/members/{memberId}/profile-groups

用于修改成员可以访问的环境分组。

路径参数

名称	类型	必填	说明
memberId	string	是	成员 ID。

请求参数

名称	类型	必填	说明
all_profile_groups	boolean	否	是否拥有全部环境分组。
profile_group_ids	string[]	否	可访问的环境分组 ID 列表。

查询成员分组列表

接口地址

GET /openapi/v2/member-groups

用于查询当前团队可用成员分组列表。

查询参数

名称	类型	必填	说明
request	string	是	角色列表查询参数。

响应参数

data.list 为成员分组列表：

名称	类型	说明
id	string	成员分组 ID。
name	string	成员分组名称。
status	string	角色状态：enabled、disabled。
remark	string	备注。

查询当前成员权限列表

接口地址

GET /openapi/v2/permissions

用于查询当前 API 密钥对应成员的权限列表。

查询参数

名称	类型	必填	说明
request	string	是	权限列表查询参数。

响应参数

data.list 为权限列表：

名称	类型	说明
id	string	权限 ID。
code	string	权限编码。
name	string	权限名称。

参数说明

成员创建和更新参数

名称	类型	必填	说明
name	string	否	成员名称。
account	string	否	成员账号。
phone	string	否	手机号。
authority	string	否	成员权限：admin、manager、staff。不允许创建或修改为 owner。
status	string	否	成员状态：enabled、disabled。
role_id	string	否	角色 ID。不允许分配超管角色组。
all_profile_groups	boolean	否	是否拥有全部环境分组。
profile_group_ids	string[]	否	可访问的环境分组 ID 列表。all_profile_groups=false 时生效。
manager_id	string	否	上级经理成员 ID。
type	string	否	成员类型：external、internal。
password	string	否	成员密码。
remark	string	否	备注。
expiry	object	否	到期停用配置，见 成员到期配置。

成员到期配置

名称	类型	必填	说明
enabled	boolean	否	是否启用到期停用。
timezone	string	否	成员时区，例如 Asia/Shanghai。
time	string	否	到期时间，格式为 yyyy-MM-dd HH:mm:ss。
mode	string	否	到期模式：instant、login_start。
days	integer	否	登录后多少天到期。mode=login_start 时生效。

成员字段

名称	类型	说明
id	string	成员 ID。
name	string	成员名称。
account	string	成员账号。
authority	string	成员权限：owner、admin、manager、staff。
status	string	成员状态：enabled、disabled。
role_id	string	角色 ID。
role_name	string	角色名称。
all_profile_groups	boolean	是否拥有全部环境分组。
profile_group_ids	string[]	可访问的环境分组 ID 列表。
profile_groups	object[]	可访问的环境分组简要信息。
type	string	成员类型：external、internal。
remark	string	备注。
created_at	string	创建时间。
updated_at	string	更新时间。