Create and Join User


不登录 EnOS 应用门户的状态下创建用户并为该用户分配组织。

操作权限


需要在 EnOS 应用门户给应用授权“在本 OU 创建或删除用户账号”的权限。

请求格式


POST https://{apigw-address}/app-portal-service/v2.2/user/createAndJoin

请求参数(Body)


名称

必需/可选

数据类型

描述

name

必需

String

用户名。

domain

必需

String

域账号对应的域在 EnOS 应用门户里注册的名称。 - 如需创建域账号,为该参数指定一个域 - 如需创建非域账号,为该参数输入空字符串

email

必需

String

用户的邮箱。

organizationId

必需

String

给用户分配的组织的 ID。如何获取 organizationId 信息>>

locale

可选

String

语言代码。不填默认为中文。

  • 英语为 en_US

  • 中文为 zh_CN

  • 西班牙语为 es_ES

  • 日语为 ja_JP

nickName

可选

String

用户的昵称。

响应参数


名称

数据类型

描述

data

Boolean

true 表示创建成功,false 表示创建失败。

错误码


代码

描述

31400

参数错误,长度错误,不能为空等

31403

应用未被授权“在本 OU 创建或删除用户账号”的权限

31404

未找到组织、域等

31408

用户名或邮箱已经存在

示例

请求示例


url: https://{apigw-address}/app-portal-service/v2.2/user/createAndJoin

method: POST

requestBody:
{"name":"yourName", "domain":"yourDomain", "email":"yourEmail", "organizationId":"yourOrgId", "locale":"zh_CN","nickName":"yourNickname"}

返回示例


{
  "code": 0,
  "message": "OK",
  "data": true
}