UpdateUser - 更新用户信息--云身份中心-火山引擎

文档中心

导航

UpdateUser - 更新用户信息

最近更新时间：2025.03.21 11:10:04首次发布时间：2025.03.21 11:10:04

更新用户信息

请求参数

下表仅列出该接口特有的请求参数和部分公共参数。更多信息请见公共参数。

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateUser	要执行的操作，取值：UpdateUser。
Version	String	是	2023-01-01	API的版本，取值：2023-01-01。
UserId	String	是	1	用户Id
UserName	String	否	username	用户名
DisplayName	String	否	displayname	显示名
Description	String	否	description	描述
Email	String	否	email@email.com	邮箱
Phone	String	否	1xxxxx	联系手机号

返回参数

本接口无特有的返回参数。更多信息请见返回结构。

请求示例

POST /?Action=UpdateUser&Version=2023-01-01 HTTP/1.1
Host: https://open.volcengineapi.com
Content-Type: application/json; charset=UTF-8
X-Date: 20250309T143715Z
X-Content-Sha256: 287e874e******d653b44d21e
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20250309/cn-beijing/cloudidentity/request, SignedHeaders=host;x-content-sha256;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

{
  "UserId": "lJelFo",
  "UserName": "用户名",
  "DisplayName": "EDSb7mdL1WN",
  "Description": "l"
}

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20250309223722028252179099C00DF3",
    "Action": "UpdateUser",
    "Version": "2023-01-01",
    "Service": "cloudidentity",
    "Region": "cn-beijing"
  },
  "Result": {}
}

错误码

下表为您列举了该接口与业务逻辑相关的错误码。公共错误码请参见公共错误码文档。

状态码	错误码	错误信息	说明
400	ParamIncludeSensitiveWord	The parameter %v Include sensitive Word	参数 %s 存在敏感词
400	ConcurrentException	Concurrent request exception	存在请求并发冲突
400	InvalidParam	The parameter %v[%v] is invalid	无效参数
400	ServiceStatusException	Can not perform action[%s] when service is %s	企业身份中心实例不可用
404	UserNotFound	User is not found	用户不存在
404	UserNameAlreadyExists	User name already exists	用户名存在
500	InternalError	Unknown internal error: %v	服务内部错误