创建用户

邀请一名用户加入当前工作区。每次邀请只能使用邮箱、手机号或 GitHub 登录名中的一种身份信息；邀请被接受前，用户可能尚不能继续管理。

POST https://moi.matrixorigin.cn/newmoi/user/create

调用前准备

确定邀请方式，并准备受邀人的一种身份信息。通过邮箱或手机号邀请时，先选择角色，确定要分配的角色和默认角色；通过 GitHub 登录名邀请且暂不分配角色时，不需要预先选择角色。

准备具有目标工作区相应权限的个人访问令牌和目标工作区 ID。

请求参数

curl -X POST "https://moi.matrixorigin.cn/newmoi/user/create" \
  -H "X-API-Key: $AI_STUDIO_API_KEY" \
  -H "X-Workspace-ID: $WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "data_analyst",
    "email": "analyst@example.com",
    "role_id_list": [1001],
    "default_role_id": 1001,
    "tag_list": []
  }'

参数

类型

是否必填

说明

name

string

是

用户在当前工作区中的名称，最长 255 个字符。

email

string

条件必填

邀请邮箱；与 mobile_number、github_login 三选一。

mobile_number

string

条件必填

中国大陆 11 位手机号；与 email、github_login 三选一。

github_login

string

条件必填

GitHub 登录名；与 email、mobile_number 三选一。

description

string

否

用户说明。

default_role_id

integer

条件必填

默认角色 ID；提供角色列表时必须属于 role_id_list。

password

string

否

兼容密码字段。

role_id_list

integer（整数数组）

条件必填

初始角色 ID 列表；邮箱或手机号邀请时不能为空。

tag_list

object（对象数组）

否

初始用户标签；每项包含 id 和 value。

tag_list[].id

integer

是

标签 ID。

tag_list[].value

string

是

标签值。

GitHub 邀请允许暂不分配角色。此时提交空的 role_id_list，并将 default_role_id 设为 0。如果 GitHub 邀请同时分配角色，默认角色仍必须包含在角色列表中。

成功响应

成功响应表示邀请请求已经处理，但不等于用户已经成为可访问工作区的活跃成员。邮箱、手机号或已能解析到账号的 GitHub 邀请返回目标用户 ID；GitHub 登录名尚未关联账号时，服务保存待处理邀请并返回空 ID。

{
  "code": "OK",
  "msg": "OK",
  "data": {
    "id": "iam-user-001"
  }
}

字段

类型

说明

code

string

成功时为 OK。

msg

string

成功时为 OK。

data.id

string

邀请目标的 IAM 用户 ID；GitHub 待处理邀请尚未关联账号时为空字符串。

错误响应

{
  "code": "INVALID_ARGUMENT",
  "msg": "请求参数无效",
  "data": null
}

字段

类型

说明

code

string

错误代码。

msg

string

错误信息。

data

null

—

后续操作

使用相同工作区确认邀请状态，再决定是否继续对该用户执行管理操作。

最后更新于