调用CreateUser创建一个EIAM账户_应用身份服务 (IDaaS)(IDaaS)-阿里云帮助中心

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

调试

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

授权信息

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

请求语法

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

请求参数

名称	类型	必填	描述	示例值
Authorization	string	是	认证信息。格式:Bearer ${access_token}。示例：Bearer ATxxxx。	Bearer AT8csE2seYxxxxxij
instanceId	string	是	实例 ID。	idaas_ue2jvisn35ea5lmthk267xxxxx
applicationId	string	是	应用 ID。	app_mkv7rgt4d7i4u7zqtzev2mxxxx
body	object	否	请求 body。
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：短信。
	string	否	密码通知渠道。	email
passwordInitializationType	string	否	密码初始化方式，取值可选范围： random：随机。	random
customFields	object []	否	账户扩展字段列表。
fieldName	string	否	扩展字段标识。类型和值域可通过控制台查看对应扩展字段值的详细信息。	age
fieldValue	string	否	扩展字段值。	fieldValue_001

返回参数

名称	类型	描述	示例值
	object	响应结果。
userId	string	账户 ID。	user_d6sbsuumeta4h66ec3il7yxxxx

示例

正常返回示例

JSON格式

{
  "userId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}

错误码

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

变更历史

变更时间

变更内容概要

操作

2023-10-24

API 内部配置变更，不影响调用

看变更集

变更项	变更内容
	API 内部配置变更，不影响调用。

错误码

HttpCode	Error Code	错误信息	说明
400	invalid_token	Access token is not valid	token 无效
400	invalid_request	Access token application id not match	请求无效，token 信息与参数应用 ID 不一致
400	OrganizationUnitIdNotInScopes	organizationUnitId : ou_wovwffm62xifdziem7an7xxxxx not in provisioning scope!	组织不存在或组织不在同步范围内
404	instance_not_found	Instance id not found: idaas_ue2jvisn35ea5lmthk267xxxxx	实例不存在
404	application_not_found	Application id not found: app_mkv7rgt4d7i4u7zqtzev2mxxxx	应用不存在
403	application_disabled	Application is disabled	应用处于禁用状态
403	application_api_disabled	Application api invoke disabled	应用 api 接口开放开关未开启
403	permission_denied	Require scopes: [urn:alibaba:idaas:scope:user:manager_all]	缺少 API 授权信息
400	MissingParameter.Username	The specified parameter:Username is required!	缺少账户名参数
400	MissingParameter.PhoneRegion	The specified parameter:PhoneRegion is required!	缺少手机区号参数，若已设置手机号，此为必填项
400	MissingParameter.PhoneNumberVerified	The specified parameter:PhoneRegion is required!	缺少手机区号是否已验证参数，若已设置手机号，此为必填项
400	MissingParameter.Email	The specified parameter:Email is required!	缺少邮箱是否已验证参数，若已设置邮箱，此为必填项
400	MissingParameter.Username	The specified parameter:Username is required!	缺少账户名参数
400	MissingParameter.PrimaryOrganizationalUnitId	The specified parameter:PrimaryOrganizationalUnitId is required!	缺少主组织参数
400	InvalidParameter.PhoneNumber	The specified parameter:PhoneNumber is invalid.	无效的手机号
400	InvalidParameter.PhoneRegion	The specified parameter:PhoneRegion is invalid.	无效的手机区号
400	InvalidParameter.Password	The specified parameter:Password is invalid.	密码不符合规则，请参考 IDaaS 控制台密码规则
400	InvalidParameter.Email	The specified parameter:Email is invalid.	无效的邮箱
400	InvalidParameter.DisplayName	The specified parameter:DisplayName is invalid.	账户显示名过长
400	InvalidParameter.Description	The specified parameter:Description is invalid.	账户描述过长
500	Internal Server Error	Internal Server Error	服务器内部错误