UpdateUser - 更新IAM用户信息--访问控制-火山引擎

文档中心

立即注册

导航

UpdateUser - 更新IAM用户信息

最近更新时间：2024.09.14 14:21:59首次发布时间：2021.02.23 10:42:32

更新指定IAM用户的信息。

调试

API Explorer

您可以通过 API Explorer 在线发起调用，无需关注签名生成过程，快速获取调用结果。

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	UpdateUser	要执行的操作，取值：UpdateUser。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	是	Bob	用户名。
NewUserName	String	否	Sean	新用户名。
NewDisplayName	String	否	肖恩	新显示名。
NewDescription	String	否	肖恩	新描述。
NewMobilePhone	String	否	130******00	新手机号。
NewEmail	String	否	abc*@.com	新电子邮件地址。

返回参数

下表仅列出本接口特有的返回参数。更多信息请参见返回结构。

参数	类型	示例值	描述
User	Object	请参考数据结构内具体参数示例值。	用户信息的数据结构。

请求示例

GET /?Action=UpdateUser&Version=2018-01-01&UserName=Bob&NewUserName=Sean HTTP/1.1
Host: iam.volcengineapi.com
X-Date: 20240914T061604Z
Authorization: HMAC-SHA256 Credential=Adfks******wekfwe/20240914/cn-beijing/iam/request, SignedHeaders=host;x-date, Signature=47a7d934ff7b37c03938******cd7b8278a40a1057690c401e92246a0e41085f

返回示例

{
  "ResponseMetadata": {
    "RequestId": "20240914141621074158130185B0E9DE",
    "Action": "UpdateUser",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "User": {
      "Id": 10000,
      "UserName": "Sean",
      "AccountId": 2000000000,
      "Trn": "trn:iam::2000000000:user/Sean",
      "DisplayName": "肖恩",
      "Description": "肖恩",
      "MobilePhone": "+86130******00",
      "MobilePhoneIsVerify": true,
      "Email": "abc**@**.com",
      "EmailIsVerify": true,
      "CreateDate": "20240813T053809Z",
      "UpdateDate": "20240813T053809Z"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidUserName	Invalid UserName '%s', err: '%s'.	用户名不合法。
400	InvalidNewUserName	Invalid NewUserName '%s', err: '%s'.	新用户名不合法。
400	InvalidDisplayName	Invalid DisplayName '%s', err: '%s'.	显示名不合法。
400	InvalidNewDisplayName	Invalid NewDisplayName '%s', err: '%s'.	新显示名不合法。
400	InvalidNewMobilePhone	Invalid NewMobilePhone '%s', err: '%s'.	新手机号不合法。
400	InvalidNewEmail	Invalid NewEmail '%s', err: '%s'.	新电子邮件地址不合法。
404	UserNotExist	User '%s' cannot be found.	用户不存在。