在指定EIAM实例下创建一个EIAM账户。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
InstanceId | string | 是 | 实例 ID。 | idaas_ue2jvisn35ea5lmthk267xxxxx |
Username | string | 是 | 账户名称,可包含英文字母、数字、符号“_” 、“ .”、“@”、“-”,长度最大限制 64 字符。 | user_001 |
DisplayName | string | 否 | 账户展示名称,长度最大限制 64 字符。 | name_001 |
Password | string | 否 | 密码,具体格式要求参考密码策略。 | 123456 |
PhoneRegion | string | 否 | 手机区号,格式为 1~6 位数字,不含"+"。 | 86 |
PhoneNumber | string | 否 | 手机号,格式为 6~15 位数字。 | 12345678901 |
PhoneNumberVerified | boolean | 否 | 手机号是否验证,为可信手机号,手机号若设置此字段必须设置,无特殊业务可直接设置为 true。 | true |
string | 否 | 邮箱,邮箱前缀可包含大写英文字母、小写英文字母、数字、点、下划线或中划线,长度限制最长为 64 字符。 | example@example.com | |
EmailVerified | boolean | 否 | 邮箱是否已验证,为可信邮箱,邮箱若设置此字段必须设置,无特殊业务可直接设置为 true。 | true |
UserExternalId | string | 否 | 账户外部 ID,用于与外部系统的关联,最大长度限制 64 字符,若不设置,默认设置为账户 ID。 | user_d6sbsuumeta4h66ec3il7yxxxx |
PrimaryOrganizationalUnitId | string | 是 | 主组织 ID。 | ou_wovwffm62xifdziem7an7xxxxx |
OrganizationalUnitIds | array | 否 | 从属组织 ID 列表,账户可从属于多个组织。 | |
string | 否 | 组织 ID。 | ou_adz2vmgiwpo4tu6jtss3mynjji | |
Description | string | 否 | 描述,最大长度限制 256 字符。 | description text |
CustomFields | array<object> | 否 | 扩展字段列表。 | description |
object | 否 | 扩展字段对象。 | ||
FieldName | string | 否 | 扩展字段标识,需提前创建相关扩展字段,参考控制台扩展字段模块。 | age |
FieldValue | string | 否 | 扩展字段值,该值遵循对应扩展字段的相关属性限制。 | 10 |
PasswordInitializationConfig | object | 否 | 密码初始化配置。 | |
PasswordInitializationPolicyPriority | string | 否 | 密码初始化策略优先级,默认不生效,取值可选范围:
| global |
PasswordForcedUpdateStatus | string | 否 | 强制修改密码状态,默认不启用,取值可选范围:
| enabled |
UserNotificationChannels | array | 否 | 密码通知渠道列表。 | |
string | 否 | 密码通知渠道,取值可选范围:
| sms | |
PasswordInitializationType | string | 否 | 密码初始化方式,取值可选范围:
| random |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "0441BD79-92F3-53AA-8657-F8CE4A2B912A",
"UserId": "user_d6sbsuumeta4h66ec3il7yxxxx"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|---|---|
2023-08-09 | API 内部配置变更,不影响调用 | 查看变更详情 |
2023-04-04 | API 内部配置变更,不影响调用 | 查看变更详情 |