用户池列表查询 - Authing 开放 API

请求参数

Query 参数

page

string

页数

可选

示例值:

1

limit

string

每页显示条数

可选

示例值:

10

Header 参数

Authorization

string

必需

用户池管理员 Token

示例值:

Bearer token

x-authing-userpool-id

string

用户池 ID

必需

示例值:

59f86b4832eb28071bdd9214

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'https://core.authing.cn/api/v2/userpools' \
--header 'Authorization: Bearer token' \
--header 'x-authing-userpool-id: 59f86b4832eb28071bdd9214'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

list

array [object {43}]

必需

totalCount

integer

必需

示例

{
    "code": 200,
    "message": "",
    "data": {
        "list": [
            {
                "frequentRegisterCheck": {
                    "timeInterval": 300,
                    "limit": 50,
                    "enabled": false
                },
                "loginFailCheck": {
                    "timeInterval": 300,
                    "limit": 50,
                    "enabled": false
                },
                "loginPasswordFailCheck": {
                    "timeInterval": 300,
                    "limit": 50,
                    "enabled": false
                },
                "passwordUpdatePolicy": {
                    "enabled": false,
                    "forcedCycle": null,
                    "differenceCycle": null
                },
                "changePhoneStrategy": {
                    "verifyOldPhone": true
                },
                "changeEmailStrategy": {
                    "verifyOldEmail": true
                },
                "qrcodeLoginStrategy": {
                    "qrcodeExpiresAfter": 120,
                    "ticketExpiresAfter": 300,
                    "returnFullUserInfo": false,
                    "allowExchangeUserInfoFromBrowser": true
                },
                "app2WxappLoginStrategy": {
                    "ticketExpiresAfter": 120,
                    "ticketExchangeUserInfoNeedSecret": false
                },
                "id": "6151e752a267059040046640",
                "createdAt": "2021-09-27T15:46:26.152Z",
                "updatedAt": "2021-09-27T15:46:26.152Z",
                "isRoot": false,
                "userId": "5a597f35085a2000144a10ed",
                "logo": "https://files.authing.co/authing-console/login_logo.svg",
                "name": "sdfwef",
                "domain": "c3tufd",
                "secret": "d75b500f21608df56fd66dc35425eb96",
                "appSsoEnabled": false,
                "allowedOrigins": "",
                "emailVerifiedDefault": false,
                "sendWelcomeEmail": true,
                "registerDisabled": false,
                "loginRequireEmailVerified": false,
                "description": "",
                "jwtSecret": "2e88bb37ca0796943dc82fa4af726210",
                "tokenExpiresAfter": 1296000,
                "isDeleted": false,
                "loginFailStrategy": "captcha",
                "userpoolTypes": null,
                "passwordStrength": 0,
                "packageType": -1,
                "defaultNamespaceId": 57,
                "systemNamespaceId": 56,
                "verifyCodeLength": 4,
                "userPoolType": "B2B",
                "internationalSmsConfig": null,
                "customPasswordStrength": {
                    "enabled": false,
                    "regex": null,
                    "message": null
                },
                "passwordFaas": {
                    "enabled": false,
                    "encryptUrl": null,
                    "decryptUrl": null,
                    "validateUrl": null
                },
                "whitelist": {
                    "phoneEnabled": false,
                    "emailEnabled": false,
                    "usernameEnabled": false
                },
                "customSMSProvider": {
                    "enabled": false,
                    "provider": null,
                    "config": null
                },
                "customDb": {
                    "cahceConfig": null,
                    "loggingConfig": null,
                    "enabled": false,
                    "mode": null,
                    "connection": null,
                    "scripts": []
                },
                "ownerId": "5a597f35085a2000144a10ed",
                "userOverview": {
                    "list": [
                        {
                            "thirdPartyIdentity": {
                                "provider": null,
                                "refreshToken": null,
                                "accessToken": null,
                                "scope": null,
                                "expiresIn": null,
                                "updatedAt": null
                            },
                            "id": "6151e753aab14f3ce814b43e",
                            "createdAt": "2021-09-27T15:46:27.142Z",
                            "updatedAt": "2021-09-27T15:46:27.142Z",
                            "userPoolId": "6151e752a267059040046640",
                            "isRoot": false,
                            "status": "Activated",
                            "oauth": null,
                            "email": null,
                            "phone": null,
                            "username": "test",
                            "unionid": null,
                            "openid": null,
                            "nickname": null,
                            "company": null,
                            "