CreateUser - 创建一个EIAM账户

调用CreateUser接口在指定组织下,创建新的EIAM的账户资源。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

当前API暂无授权信息透出。

请求语法

POST /v2/{instanceId}/{applicationId}/users HTTP/1.1

请求参数

名称

类型

必填

描述

示例值

Authorization

string

认证信息。 格式:Bearer ${access_token}。 示例:Bearer ATxxxx。

Bearer AT8csE2seYxxxxxij

instanceId

string

实例 ID。

idaas_ue2jvisn35ea5lmthk267xxxxx

applicationId

string

应用 ID。

app_mkv7rgt4d7i4u7zqtzev2mxxxx

body

object

请求 body。

app_xx001

username

string

账户名称,可包含英文字母、数字、符号“_” 、“ .”、“@”、“-”,长度最大限制 64 字符。

name001

displayName

string

账户展示名。长度限制最长为 64 字符。

display_name001

password

string

账户密码,密码规则参考 IDaaS 控制台密码策略。

xxxxx

phoneRegion

string

手机地区编号,示例:中国大陆手区号为 86,不带 00 或 +, 手机号若设置,此参数必填。

86

phoneNumber

string

账户手机号,格式为 6~15 位数字。

156xxxxxxx

phoneNumberVerified

boolean

手机号是否验证,手机号若设置此字段必须设置,无特殊业务可直接设置为 true。

true

email

string

邮箱,邮箱前缀可包含大写英文字母、小写英文字母、数字、点、下划线或中划线,长度限制最长为 64 字符。

example@example.com

emailVerified

boolean

邮箱是否验证,邮箱若设置此字段必须设置,无特殊业务可直接设置为 true。

true

userExternalId

string

账户外部 ID,用于与外部系统的关联,最大长度限制 64 字符,若不设置,默认设置为账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

primaryOrganizationalUnitId

string

主组织 ID。

ou_wovwffm62xifdziem7an7xxxxx

description

string

账户描述,长度限制最长为 256 字符。

测试账户

passwordInitializationConfig

object

密码初始化配置。

passwordInitializationPolicyPriority

string

密码初始化策略优先级,默认不生效,取值可选范围:

  • global:全局优先,采用实例级别的密码初始化策略,即本次设置的密码初始化策略均无效,参考密码相关策略的密码初始化策略。

  • custom:自定义优先,以当前定义的密码初始化策略为准,包括是否开启强制改密、密码初始化方式以及通知渠道。

global

passwordForcedUpdateStatus

string

强制修改密码状态,默认不启用,取值可选范围:

  • enabled:开启。

  • disabled:禁用。

enabled

userNotificationChannels

array

密码通知渠道,取值可选范围:

  • email:邮件。

  • sms:短信。

sms

string

密码通知渠道。

email

passwordInitializationType

string

密码初始化方式,取值可选范围:

  • random:随机。

random

customFields

array

账户扩展字段列表。

object

扩展字段标识和值对象。

fieldName

string

扩展字段标识。类型和值域可通过控制台查看对应扩展字段值的详细信息。

age

fieldValue

string

扩展字段值。

fieldValue_001

返回参数

名称

类型

描述

示例值

object

响应结果。

userId

string

账户 ID。

user_d6sbsuumeta4h66ec3il7yxxxx

示例

正常返回示例

JSON格式

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

错误码

访问错误中心查看更多错误码。

变更历史

更多信息,参考变更详情