CreateUser - 创建IAM用户--访问控制-火山引擎

文档中心

立即注册

导航

CreateUser - 创建IAM用户

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

创建IAM用户。

调试

API Explorer

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

去调试

请求参数

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

参数	类型	是否必填	示例值	描述
Action	String	是	CreateUser	要执行的操作，取值：CreateUser。
Version	String	是	2018-01-01	API的版本，取值：2018-01-01。
UserName	String	是	Bob	用户名。
DisplayName	String	否	鲍勃	用户显示名。
Description	String	否	鲍勃	用户备注。
Email	String	否	abc@.com	电子邮件地址。
MobilePhone	String	否	+86130******00	手机号。
Tags.N.Key	Array of String	否	department	给用户附加标签的标签键。使用UTF-8编码的Unicode，长度为1~128字符，允许任何语言文字、数字、空格和_ . : / = + - @符号。每个角色至多附加50对标签。
Tags.N.Value	Array of String	否	dev	给用户附加标签的标签值。使用UTF-8编码的Unicode，长度为0~256字符（即Value可以为空），允许任何语言文字、数字、空格和_ . : / = + - @符号。每个角色至多附加50对标签。

返回参数

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

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

请求示例

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

返回示例

{
  "ResponseMetadata": {
    "RequestId": "202409131905490522331661975DCC8D",
    "Action": "CreateUser",
    "Version": "2018-01-01",
    "Service": "iam",
    "Region": "cn-beijing"
  },
  "Result": {
    "User": {
      "Id": 10000,
      "UserName": "Bob",
      "AccountId": 2000000000,
      "Trn": "trn:iam::2000000000:user/Bob",
      "DisplayName": "鲍勃",
      "Description": "鲍勃",
      "MobilePhone": "+86130******00",
      "MobilePhoneIsVerify": true,
      "Email": "abc**@**.com",
      "EmailIsVerify": true,
      "CreateDate": "20240813T053809Z",
      "UpdateDate": "20240813T053809Z"
    }
  }
}

错误码

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

状态码	错误码	错误信息	说明
400	InvalidUserName	Invalid UserName '%s', err: '%s'.	用户名不合法。
400	InvalidDisplayName	Invalid DisplayName '%s', err: '%s'.	用户显示名不合法。
400	InvalidMobilePhone	Invalid MobilePhone '%s', err: '%s'.	用户手机号码不合法。
400	InvalidEmail	Invalid Email '%s', err: '%s'.	用户电子邮件地址不合法。
409	UserAlreadyExists	User '%s' already exists.	用户已存在。