创建用户 - IDMesh APIs

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

Body 参数application/json

username

string

可选

用户名，租户内唯一，若不传后台自动生成

password

string

可选

密码，若不传后台生成默认密码

password_status

string

可选

valid 有效，invalid 无效（强制修改），init 初始待生效

display_name

string

可选

显示名称，如"张三"

firstname

string

可选

名（First Name），如"Bill"

lastname

string

可选

姓（Last Name），如"Gates"

realname

string

可选

真实姓名，如"张三"

pinyin

string

可选

拼音，如"lihai"

nickname

string

可选

昵称，如"Jams"

user_type

string

可选

用户类型（可自由定义，若传空值，后台设置系统默认类型）

area_code

string

区号

可选

手机号的国际区号，若不填默认值为"+86"

mobile

string

可选

手机号，如"13918201111"

email

string

可选

邮箱，如"alice@microsoft.com"

gender

string

性别：1男，0女

可选

cert_type

string

可选

证件类型（见通用字典表）

cert_number

string

可选

证件号，如"310102199001023320"

region

string

区域，如"上海"

可选

work_time

string

可选

加入时间/入职时间，如"2024-02-02"

work_title

string

可选

职位，如"高级建筑师"

idp_config_id

number

必需

身份源ID，作为创建时记录，不做更新。
身份源ID是从身份源列表接口请求中获取的idp_config_id。

sys_ext_props

object

可选

系统扩展属性，json对象
示例值：
{"age": 18, "love": "足球"}
注意：系统扩展属性必须遵循扩展字段的Schema

free_ext_props

object

可选

自由扩展属性，json对象

relation_data

object

可选

组织和岗位的关系映射信息
"relation_data": [{
// 组织ID，第三方应用调用可不传
"node_id": xxx,
// 组织编码
"code": "xxx",
// 组织类型
"object_code": "xxx",
// 是否为主要关系，1是0否
"is_default": "1"
}]
支持多条关系，但其中必须有且只有一条主要关系的记录。

is_notify

boolean

可选

是否通知：false不通知（不传值默认为false），true通知

external_id

string

可选

同步自外部系统的ID

示例

{
    "idp_config_id": 8,
    "relation_data": [
    {
        "code": "123123",
        "object_code": "ldap_test",
        "is_default": "1"
    },
    {
        "code": "asdfasdfasdfas",
        "object_code": "ldap_test",
        "is_default": "0"
    }
]

}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST '/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "idp_config_id": 8,
    "relation_data": [
    {
        "code": "123123",
        "object_code": "ldap_test",
        "is_default": "1"
    },
    {
        "code": "asdfasdfasdfas",
        "object_code": "ldap_test",
        "is_default": "0"
    }
]

}'

返回响应

🟢200成功

application/json

Body

id

string

唯一标识

可选

示例

{
    "id": "string"
}

🟠400参数错误