创建用户 - Authok管理API

请求参数

Authorization

在 Header 添加参数

Authorization

，其值为在 Bearer 之后拼接 Token

示例：

Authorization: Bearer ********************

Body 参数application/json

创建用户

connection

string

身份源

必需

email

string

邮箱

可选

phone_number

string

手机号

可选

username

string

可选

用户名(唯一标识符, 可用于用户名/密码登录)

picture

string | null

头像地址

可选

gender

enum<integer>

可选

性别. 0: 未知; 1: 男; 2: 女

>= 0<= 2

枚举值:

012

force_reset_password

boolean

新用户强制设置密码

可选

nickname

string

昵称

可选

name

string

姓名

可选

phone_number_verified

boolean

可选

手机号是否经过验证

given_name

string

名

可选

family_name

string

姓

可选

password

string

密码

可选

user_metadata

object

可选

用户元数据(用户属性，用户可设置)

app_metadata

object

可选

应用元数据(应用级别设置，用户不可设置)

blocked

boolean

可选

账号是否被锁定(锁定后无法正常登录)

示例

{
    "connection": "authok",
    "gender": 1,
    "picture": "https://img.gavatars.com/a.png",
    "phone_number_verified": true,
    "email": "fioman@qq.com",
    "password": "compoejffio@jfowfjeio",
    "phone_number": "18600002222",
    "force_reset_password": true,
    "name": "李雷",
    "given_name": "类",
    "app_metadata": {},
    "family_name": "李",
    "user_metadata": {},
    "blocked": false,
    "username": "fioman",
    "nickname": "fioman"
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location -g --request POST 'https://..authok.cn/api/v1/users' \
--header 'Content-Type: application/json' \
--data-raw '{
    "connection": "authok",
    "gender": 1,
    "picture": "https://img.gavatars.com/a.png",
    "phone_number_verified": true,
    "email": "fioman@qq.com",
    "password": "compoejffio@jfowfjeio",
    "phone_number": "18600002222",
    "force_reset_password": true,
    "name": "李雷",
    "given_name": "类",
    "app_metadata": {},
    "family_name": "李",
    "user_metadata": {},
    "blocked": false,
    "username": "fioman",
    "nickname": "fioman"
}'

返回响应

🟢200成功

application/json

Body

用户信息

user_id

string

必需

用户ID(租户内唯一)

connection

string

身份源

必需

name

string

姓名

可选

email

string

邮箱

可选

email_verified

boolean

邮箱是否验证

可选

phone_number

string

手机号

可选

phone_country_code

string

手机国家代码

可选

phone_number_verified

boolean

手机号是否验证

可选

logins_count

integer

登录累积次数

必需

blocked

boolean

必需

账号是否被锁定(锁定后无法正常登录)

identities

array[object (Identity) {6}]

绑定的身份信息列表

必需

connection

string

身份源标识符

必需

user_id

string

用户ID

必需

provider

string

身份提供者

必需

is_social

boolean

是否社交身份源

必需

access_token

string

访问令牌

必需

profile_data

object

用户详情

必需

user_metadata

object

可选

用户元数据(用户属性，用户可设置)

app_metadata

object

可选

应用元数据(应用级别设置，用户不可设置)

signup_at

string

注册时间

必需

updated_at

string

最后更新时间

必需

created_at

string

用户创建时间

必需

username

string

可选

用户名(唯一标识符, 可用于用户名/密码登录)

nickname

string

昵称

可选

given_name

string

名

可选

family_name

string

姓

可选

picture

string | null

头像地址

可选

verify_email

boolean

邮箱是否已经过验证

可选

gender

integer

可选

性别. 0: 未知; 1: 男; 2: 女

birthdate

string

生日

可选

locale

string

区域

可选

country

string

所在国家

可选

city

string

城市

可选

province

string

省份

可选

region

string

南山区

可选

address

string

详细地址

可选

postal_code

string

邮政编码

可选

signup_ip

string

注册IP

必需

last_login

string

最后登录时间

必需

last_ip

string

最后登录IP

必需

示例

{
    "user_id": "authok|32jjf9uwfjew0ejfjffeio",
    "connection": "authok",
    "logins_count": 1002,
    "blocked": false,
    "identities": [
        {
            "connection": "wechat",
            "user_id": "26",
            "provider": "76",
            "is_social": true,
            "access_token": "non voluptate",
            "profile_data": {
                "email": "y.xmoec@qq.com",
                "emailVerified": false,
                "name": "处包气",
                "username": "毛艳",
                "given_name": "因今理增",
                "phone_number": "56",
                "phone_number_verified": true,
                "family_name": "即越西流",
                "picture": "http://dummyimage.com/400x400",
                "city": "湘潭市",
                "province": "广东省",
                "country": "ut adipisicing",
                "gender": 61,
                "nickname": "金杰",
                "openid": "36",
                "unionid": "91"
            }
        }
    ],
    "signup_at": "2022-03-12 22:33:44",
    "updated_at": "2022-03-12 23:33:44",
    "signup_ip": "22.33.21.52",
    "last_login": "2022-03-13 18:22:12",
    "last_ip": "22.33.21.53",
    "created_at": "2022-03-11 23:33:44",
    "country": "中国",
    "phone_number_verified": true,
    "phone_country_code": "86",
    "nickname": "fioman",
    "city": "深圳",
    "user_metadata": {},
    "email_verified": true,
    "locale": "zh",
    "phone_number": "18600002222",
    "username": "fioman",
    "app_metadata": {},
    "postal_code": "518000",
    "birthdate": "1987-04-23",
    "picture": "https://img.gavatars.com/a.png",
    "gender": 1,
    "verify_email": true,
    "email": "fioman@qq.com",
    "family_name": "李",
    "address": "粤海街道办A座A03室",
    "province": "广东",
    "region": "区域",
    "given_name": "雷",
    "name": "李雷"
}