创建用户 - Authing 开放 API

请求参数

Header 参数

Authorization

string

Token

必需

示例值:

Bearer sdfsf

x-authing-userpool-id

string

用户池 ID

必需

示例值:

61b95d6c96d42670da568408

Body 参数application/json

userInfo

object

必需

username

string

用户名

必需

email

string

邮箱

必需

emailVerified

boolean

可选

邮箱是否已认证，默认 false

phone

string

手机号

必需

resetPasswordOnFirstLogin

boolean

可选

是否在首次登录时重置密码，默认 false

keepPassword

boolean

可选

迁移用户时使用，默认值 false。设置 keepPassword 为 true 之后，我们就不会再次对密码进行加密，而是直接保存

示例

{
    "userInfo": {
        "username": "string",
        "email": "string",
        "emailVerified": true,
        "phone": "string"
    },
    "resetPasswordOnFirstLogin": true,
    "keepPassword": true
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://core.authing.cn/api/v2/users' \
--header 'Authorization: Bearer sdfsf' \
--header 'x-authing-userpool-id: 61b95d6c96d42670da568408' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userInfo": {
        "username": "string",
        "email": "string",
        "emailVerified": true,
        "phone": "string"
    },
    "resetPasswordOnFirstLogin": true,
    "keepPassword": true
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

thirdPartyIdentity

object

必需

userPoolId

string

必需

email

string

必需

phone

string

必需

username

string

必需

registerSource

array[string]

必需

emailVerified

boolean

必需

resetPasswordOnFirstLogin

boolean

必需

createdAt

string

必需

updatedAt

string

必需

id

string

必需

oauth

null

必需

unionid

null

必需

openid

null

必需

nickname

null

必需

company

null

必需

photo

string

必需

browser

null

必需

device

null

必需

password

null

必需

salt

null

必需

lastIp

null

必需

name

null

必需

givenName

null

必需

familyName

null

必需

middleName

null

必需

profile

null

必需

preferredUsername

null

必需

website

null

必需

birthdate

null

必需

zoneinfo

null

必需

locale

null

必需

address

null

必需

formatted

null

必需

streetAddress

null

必需

locality

null

必需

region

null

必需

postalCode

null

必需

city

null

必需

province

null

必需

country

null

必需

secretInfo

null

必需

lastLogin

null

必需

encryptedPassword

null

必需

signedUp

null

必需

externalId

null

必需

mainDepartmentId

null

必需

mainDepartmentCode

null

必需

lastMfaTime

null

必需

passwordSecurityLevel

null

必需

syncExtInfo

null

必需

phoneCountryCode

null

必需

isRoot

boolean

必需

status

string

必需

loginsCount

integer

必需

gender

string

必需

phoneVerified

boolean

必需

blocked

boolean

必需

isDeleted

boolean

必需

sendSmsCount

integer

必需

sendSmsLimitCount

integer

必需

_id

string

必需

registerMethod

string

必需

registerInClient

string

必需

lastIP

null

必需

示例

{
    "code": 200,
    "message": "创建用户成功",
    "data": {
        "thirdPartyIdentity": {
            "provider": null,
            "refreshToken": null,
            "accessToken": null,
            "scope": null,
            "expiresIn": null,
            "updatedAt": null
        },
        "userPoolId": "61b95d6c96d42670da568408",
        "email": "112233@gmail.com",
        "phone": "13100000001",
        "username": "13100000001",
        "registerSource": [
            "import:manual"
        ],
        "emailVerified": false,
        "resetPasswordOnFirstLogin": false,
        "createdAt": "2022-01-12T06:42:51.070Z",
        "updatedAt": "2022-01-12T06:42:51.070Z",
        "id": "61de786b31d27307c7ce66c3",
        "oauth": null,
        "unionid": null,
        "openid": null,
        "nickname": null,
        "company": null,
        "photo": "https://files.authing.co/authing-console/default-user-avatar.png",
        "browser": null,
        "device": null,
        "password": null,
        "salt": null,
        "lastIp": null,
        "name": null,
        "givenName": null,
        "familyName": null,
        "middleName": null,
        "profile": null,
        "preferredUsername": null,
        "website": null,
        "birthdate": null,
        "zoneinfo": null,
        "locale": null,
        "address": null,
        "formatted": null,
        "streetAddress": null,
        "locality": null,
        "region": null,
        "postalCode": null,
        "city": null,
        "province": null,
        "country": null,
        "secretInfo": null,
        "lastLogin": null,
        "encryptedPassword": null,
        "signedUp": null,
        "externalId": null,
        "mainDepartmentId": null,
        "mainDepartmentCode": null,
        "lastMfaTime": null,
        "passwordSecurityLevel": null,
        "syncExtInfo": null,
        "phoneCountryCode": null,
        "isRoot": false,
        "status": "Activated",
        "loginsCount": 0,
        "gender": "U",
        "phoneVerified": false,
        "blocked": false,
        "isDeleted": false,
        "sendSmsCount": 0,
        "sendSmsLimitCount": 1000,
        "_id": "61de786b31d27307c7ce66c3",
        "registerMethod": "import:manual",
        "registerInClient": "61b95d6c96d42670da568408",
        "lastIP": null
    }
}