文档首页> IAM 身份中心> API参考> API> 用户管理> 创建用户
更新时间：2024-04-29 GMT+08:00
在线调试
CLI示例
查看PDF
分享

创建用户

功能介绍

在指定的身份源中创建一个IAM身份中心用户。

URI

POST /v1/identity-stores/{identity_store_id}/users

表1 路径参数

参数

是否必选

参数类型

描述

identity_store_id

是

String

身份源的全局唯一标识符（ID）

最小长度：12

最大长度：12

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

X-Security-Token

否

String

如果正在使用临时安全凭据，则此header是必需的，该值是临时安全凭据的安全令牌（会话令牌）。

最大长度：2048
表3 请求Body参数

参数

是否必选

参数类型

描述

addresses

否

Array of objects

用户的地址信息列表。

数组长度：1-1

display_name

是

String

用户的显示名称。

最小长度：1

最大长度：1024

emails

是

Array of objects

用户的电子邮箱信息列表。

数组长度：1-1

locale

否

String

用户的地理区域或位置信息。

最小长度：1

最大长度：1024

name

是

Object

包含用户姓名信息的对象。

nickname

否

String

用户昵称。

最小长度：1

最大长度：1024

phone_numbers

否

Array of objects

用户的电话号码信息列表。

数组长度：1-1

preferred_language

否

String

用户语言首选项。

最小长度：1

最大长度：1024

profile_url

否

String

与用户关联的URL。

最小长度：1

最大长度：1024

timezone

否

String

用户时区。

最小长度：1

最大长度：1024

title

否

String

用户头衔。

最小长度：1

最大长度：1024

user_name

是

String

用户名，用于标识用户的唯一字符串。

最小长度：2

最大长度：128

user_type

否

String

用户类型。

最小长度：1

最大长度：1024

password_mode

是

String

初始化密码方式，一次性密码/邮箱。

枚举值：

  • OTP
  • EMAIL

enterprise

否

Object

包含用户工作相关信息的对象。
表4 addresses

参数

是否必选

参数类型

描述

country

否

String

国家/地区。

最小长度：1

最大长度：1024

formatted

否

String

包含要显示的地址的格式化版本的字符串。

最小长度：1

最大长度：1024

locality

否

String

地址位置。

最小长度：1

最大长度：1024

postal_code

否

String

邮政编码。

最小长度：1

最大长度：1024

primary

否

Boolean

一个布尔值，表示这是否为用户的主地址。

region

否

String

区域。

最小长度：1

最大长度：1024

street_address

否

String

街道。

最小长度：1

最大长度：1024

type

否

String

表示地址类型的字符串。

最小长度：1

最大长度：1024
表5 emails

参数

是否必选

参数类型

描述

primary

是

Boolean

一个布尔值，表示这是否为用户的主电子邮箱。

type

是

String

表示电子邮箱类型的字符串。

最小长度：1

最大长度：1024

value

是

String

包含电子邮箱地址的字符串。

最小长度：1

最大长度：1024

verification_status

否

String

电子邮箱地址的验证状态。

枚举值：

  • NOT_VERIFIED
  • VERIFIED
表6 name

参数

是否必选

参数类型

描述

family_name

是

String

用户的姓氏。

最小长度：1

最大长度：1024

formatted

否

String

包含要显示的名称的格式化版本的字符串。

最小长度：1

最大长度：1024

given_name

是

String

用户的名字。

最小长度：1

最大长度：1024

honorific_prefix

否

String

用户的尊称前缀。

最小长度：1

最大长度：1024

honorific_suffix

否

String

用户的尊称后缀。

最小长度：1

最大长度：1024

middle_name

否

String

用户的中间名。

最小长度：1

最大长度：1024
表7 phone_numbers

参数

是否必选

参数类型

描述

primary

否

Boolean

一个布尔值，表示这是否为用户的主电话号码。

type

否

String

表示电话号码类型的字符串。

最小长度：1

最大长度：1024

value

否

String

包含电话号码的字符串。

最小长度：1

最大长度：1024
表8 enterprise

参数

是否必选

参数类型

描述

cost_center

否

String

成本中心。

最小长度：1

最大长度：1024

department

否

String

部门。

最小长度：1

最大长度：1024

division

否

String

分部。

最小长度：1

最大长度：1024

employee_number

否

String

员工编号。

最小长度：1

最大长度：1024

manager

否

Object

经理。

organization

否

String

组织。

最小长度：1

最大长度：1024
表9 manager

参数

是否必选

参数类型

描述

value

否

String

经理。

最小长度：1

最大长度：1024

响应参数

状态码： 201

表10 响应Body参数

参数

参数类型

描述

identity_store_id

String

身份源的全局唯一标识符（ID）。

最小长度：1

最大长度：36

user_id

String

身份源中IAM身份中心用户的全局唯一标识符（ID）。

最小长度：1

最大长度：47

password

String

用于初始化密码的一次性密码。

状态码： 400

表11 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

状态码： 403

表12 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

状态码： 409

表13 响应Body参数

参数

参数类型

描述

error_code

String

错误码。

error_msg

String

错误信息。

request_id

String

请求ID。

encoded_authorization_message

String

鉴权信息。

请求示例

在指定的身份源中创建一个IAM身份中心用户。

POST https://{hostname}/v1/identity-stores/{identity_store_id}/users

{
  "user_name" : "用户名u1",
  "display_name" : "用户显示名",
  "emails" : [ {
    "primary" : true,
    "type" : "Work",
    "value" : "email@example.com"
  } ],
  "name" : {
    "family_name" : "姓氏",
    "given_name" : "名字"
  },
  "password_mode" : "OTP"
}

响应示例

状态码： 201

Successful

{
  "identity_store_id" : "d-a00aaaa33f",
  "user_id" : "ac6aa714-daa7-1aaa-aaa2-6715aaaa4dd9",
  "password" : "one-time-password-123"
}

状态码

请参见状态码。

错误码

请参见错误码。

父主题： 用户管理
分享：

    相关文档

    相关产品