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

文档中心

立即注册

导航

UpdateUser - 更新用户

最近更新时间：2024.08.13 13:58:11首次发布时间：2021.02.23 10:42:32

更新用户信息。

调试

API Explorer

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

去调试

请求参数

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

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

返回参数

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

参数	类型	示例值	描述
User	Object	--	用户信息的数据结构。

请求示例

GET /?Action=UpdateUser&UserName=Alice&NewUserName=Alice1&Version=2018-01-01 HTTP/1.1
Accept: application/json
Content-Type: application/x-www-form-urlencoded
Host: iam.volcengineapi.com
X-Date: 20180614T104526Z
Authorization: HMAC-SHA256 Credential=AKIAIAGMBG4SXSQQ54MQ/20180614/cn-north-1/iam/request, SignedHeaders=content-type;host;x-date, Signature=483c5b4a8d5d2f2960e162e8ce449c807539681b71ab11676eea301e1ef******

返回示例

{
    "ResponseMetadata": {
        "RequestId": "201806041104200100100232280022D30",
        "Action": "UpdateUser",
        "Version": "2018-01-01",
        "Service": "iam",
        "Region": "cn-north-1"
    },
    "Result":{
        "User": {
            "CreateDate": "20181019T101043Z",
            "UpdateDate": "20181019T101043Z",
            "Trn": "trn:iam::20000*****:user/tiansm",
            "UserName": "tiansm",
            "Description": "",
            "DisplayName": "",
            "Email": "",
            "EmailIsVerify": false,
            "MobilePhone": "130********",
            "MobilePhoneIsVerify": false
        }
          }
}

错误码

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

状态码	错误码	错误信息
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.