帮你快速理解、总结文档立即下载

创建用户

最近更新时间:2022-12-06 15:46:59
我的收藏

接口描述

创建用户信息。

HTTP 请求方法

POST

请求路径

/scim/api/v2/Users

请求参数

参数名称
必选
类型
参数类型
描述
userName
是
string
body
用户名,长度不超过64字符
displayName
是
string
body
显示名,长度不超过32字符
organization
是
array,string
body
组织机构 id
group
否
array,string
body
用户组 id
description
否
string
body
用户备注信息,长度不超过255字符
expireDate
否
string
body
过期时间,格式为:2010-01-23T04:56:22Z
password
是
string
body
用户密码
phoneNumbers
否
array,object
body
用户电话,默认使用第一个
- value
是
string
body
电话,格式:+86-1xxxxxxxxx5
emails
否
array,object
body
用户邮箱,默认使用第一个
- value
是
string
body
邮箱
createDate
否
string
body
创建时间,格式为:2010-01-23T04:56:22Z
extendFields
否
object
body
自定义属性

响应状态码

状态码
返回值
描述
201
ok
创建成功
400
bad request
参数错误

返回字段

参数名称
类型
参数类型
描述
errcode
Integer
Body
出错返回码,为0表示成功,非0表示调用失败
errmsg
String
Body
描述信息
id
String
Body
在 IDAM 当中的唯一标识

接口示例

入参示例

http://<host>:<ip>/scim/api/v2/Users
{
"userName": "test",
"displayName": "test",
"password": "123456",
"emails": [
{
"value": "22334@qq.com",
}
],
"phoneNumbers": [
{
"value": "+86-19981285889",
}
],
"organization": ["97d436f5-6b27-48e6-b60b-cf9665c49105"],
"group":["97d436f5-6b27-48e6-b60b-cf9665c49105"],
"createDate":"2010-01-23T04:56:22Z",
"extendFields": {
"test3": "test3-7777"
}
}


返回示例

{
"errcode": 0,
"errmsg": "created",
"id":"97d436f5-6b27-48e6-b60b-cf9665c49105"
}