UpdateMember - 更新成员信息

更新时间:
复制 MD 格式

通过 OpenAPI 部分更新组织成员属性:未提供字段保持原值;文本字段 name 传空字符串等同未传、保持原值;nickName / email / staffId 例外,传空字符串表示清空该字段。name 与 nickName 最多 50 字符(nickName 传空则清空),email 需为合法格式且最多 200 字符(传空则清空),staffId 最多 50 字符(传空则清空)。组织拥有者不可更新;已停用 / 已删除成员不可更新。deptIds 与 roleIds 仅支持「len>0 的全量集合做替换」,所含 ID 必须存在且属于本组织;传 nil 或 [] 均保持原值;如需清空 / 重置部门或角色,请使用 MoveMemberDepartments / UpdateMemberRoles 等独立接口。

适用版本

Region版

服务接入点与授权信息

产品

资源

所需权限

组织管理

组织成员

读写

请求语法

Region版

PUT https://{domain}/oapi/v1/platform/members/{id}

请求头

参数

类型

是否必填

描述

示例值

x-yunxiao-token

string

是

个人访问令牌。

pt-0fh3****0fbG_35af****0484

请求参数

参数

类型

位置

是否必填

描述

示例值

id

string

path

是

组织成员 ID。

-

object

body

否

deptIds

array[string]

body

否

部门 ID 全量集合,传 nil 或 [] 均保持原值;不支持以 [] 清空。

["99d1****6124"]

email

string

body

否

邮箱,组织内唯一,最多200个字符,传空则清空邮箱。

zhangsan@example.com

name

string

body

否

成员名称,最多50个字符,传空保持原值。

示例名

nickName

string

body

否

昵称,最多50个字符,传空则清空昵称。

张三

roleIds

array[string]

body

否

角色 ID 全量集合,传 nil 或 [] 均保持原值;不支持以 [] 清空。

["99d1****6124"]

staffId

string

body

否

工号,组织内唯一,最多50个字符,传空则清空工号。

E001

请求示例

Region版

curl -X 'PUT' \
  'https://{domain}/oapi/v1/platform/members/{id}' \
  -H 'Content-Type: application/json' \
  -H 'x-yunxiao-token: pt-0fh3****0fbG_35af****0484' \
  --data '
    {
        "deptIds": ["99d1****6124"],
        "email": "zhangsan@example.com",
        "name": "示例名",
        "nickName": "张三",
        "roleIds": ["99d1****6124"],
        "staffId": "E001"
    }'

返回参数

参数

类型

描述

示例值

-

object

deptIds

array[string]

所属组织部门列表。

["99d1****6124"]

email

string

邮箱。

example@example.com

id

string

成员 ID。

99d1****6124

joined

string

加入时间。

2023-08-31T03:59:16.201Z

lastUpdated

string

最后更新时间,等于数据库的更新时间。

2023-08-31T03:59:16.201Z

name

string

成员名。

示例名

nickName

string

昵称。

张三

organizationId

string

组织 ID。

99d1****6124

roleIds

array[string]

角色信息。

["99d1****6124"]

staffId

string

工号。

E001

status

string

成员状态,可选值:ENABLED,DISABLED,UNDELETED,DELETED,NORMAL_USING,UNVISITED。

ENABLED

userId

string

用户 ID。

99d1****6124

username

string

用户名,格式:xxx_{组织标识}。

zhangsan_org1

visited

string

最后访问时间。

2023-08-31T03:59:16.201Z

返回示例

{
    "deptIds": ["99d1****6124"],
    "email": "example@example.com",
    "id": "99d1****6124",
    "joined": "2023-08-31T03:59:16.201Z",
    "lastUpdated": "2023-08-31T03:59:16.201Z",
    "name": "示例名",
    "nickName": "张三",
    "organizationId": "99d1****6124",
    "roleIds": ["99d1****6124"],
    "staffId": "E001",
    "status": "ENABLED",
    "userId": "99d1****6124",
    "username": "zhangsan_org1",
    "visited": "2023-08-31T03:59:16.201Z"
}

错误码

访问错误码中心查看 API 相关错误码。