密码安全设置修改 - Authing 开放 API

请求参数

Header 参数

Authorization

string

必需

用户池管理员 Token

示例值:

Bearer token

x-authing-userpool-id

string

用户池 ID

必需

示例值:

59f86b4832eb28071bdd9214

Body 参数application/json

frequentRegisterCheck

object

必需

timeInterval

integer

必需

limit

integer

必需

enabled

boolean

必需

loginFailCheck

object

必需

timeInterval

integer

必需

limit

integer

必需

enabled

boolean

必需

loginPasswordFailCheck

object

必需

timeInterval

integer

必需

limit

integer

必需

enabled

boolean

必需

passwordUpdatePolicy

object

必需

enabled

boolean

必需

forcedCycle

null

必需

differenceCycle

null

必需

changePhoneStrategy

object

必需

verifyOldPhone

boolean

必需

changeEmailStrategy

object

必需

verifyOldEmail

boolean

必需

qrcodeLoginStrategy

object

必需

qrcodeExpiresAfter

integer

必需

ticketExpiresAfter

integer

必需

returnFullUserInfo

boolean

必需

allowExchangeUserInfoFromBrowser

boolean

必需

app2WxappLoginStrategy

object

必需

ticketExpiresAfter

integer

必需

ticketExchangeUserInfoNeedSecret

boolean

必需

string

必需

createdAt

string

必需

updatedAt

string

必需

isRoot

boolean

必需

userId

string

必需

logo

string

必需

name

string

必需

domain

string

必需

secret

string

必需

appSsoEnabled

boolean

必需

allowedOrigins

string

必需

emailVerifiedDefault

boolean

必需

sendWelcomeEmail

boolean

必需

registerDisabled

boolean

必需

loginRequireEmailVerified

boolean

必需

description

string

必需

jwtSecret

string

必需

tokenExpiresAfter

integer

必需

isDeleted

boolean

必需

loginFailStrategy

string

必需

userpoolTypes

null

必需

passwordStrength

integer

必需

packageType

integer

必需

defaultNamespaceId

integer

必需

systemNamespaceId

integer

必需

verifyCodeLength

integer

必需

userPoolType

string

必需

internationalSmsConfig

null

必需

customPasswordStrength

object

必需

enabled

boolean

必需

regex

null

必需

message

null

必需

passwordFaas

object

必需

enabled

boolean

必需

encryptUrl

null

必需

decryptUrl

null

必需

validateUrl

null

必需

whitelist

object

必需

phoneEnabled

boolean

必需

emailEnabled

boolean

必需

usernameEnabled

boolean

必需

customSMSProvider

object

必需

enabled

boolean

必需

provider

null

必需

config

null

必需

customDb

object

必需

cahceConfig

null

必需

loggingConfig

null

必需

enabled

boolean

必需

mode

null

必需

connection

null

必需

scripts

array[string]

必需

示例

{
    "frequentRegisterCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "loginFailCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "loginPasswordFailCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "passwordUpdatePolicy": {
        "enabled": true,
        "forcedCycle": null,
        "differenceCycle": null
    },
    "changePhoneStrategy": {
        "verifyOldPhone": true
    },
    "changeEmailStrategy": {
        "verifyOldEmail": true
    },
    "qrcodeLoginStrategy": {
        "qrcodeExpiresAfter": 0,
        "ticketExpiresAfter": 0,
        "returnFullUserInfo": true,
        "allowExchangeUserInfoFromBrowser": true
    },
    "app2WxappLoginStrategy": {
        "ticketExpiresAfter": 0,
        "ticketExchangeUserInfoNeedSecret": true
    },
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "isRoot": true,
    "userId": "string",
    "logo": "string",
    "name": "string",
    "domain": "string",
    "secret": "string",
    "appSsoEnabled": true,
    "allowedOrigins": "string",
    "emailVerifiedDefault": true,
    "sendWelcomeEmail": true,
    "registerDisabled": true,
    "loginRequireEmailVerified": true,
    "description": "string",
    "jwtSecret": "string",
    "tokenExpiresAfter": 0,
    "isDeleted": true,
    "loginFailStrategy": "string",
    "userpoolTypes": null,
    "passwordStrength": 0,
    "packageType": 0,
    "defaultNamespaceId": 0,
    "systemNamespaceId": 0,
    "verifyCodeLength": 0,
    "userPoolType": "string",
    "internationalSmsConfig": null,
    "customPasswordStrength": {
        "enabled": true,
        "regex": null,
        "message": null
    },
    "passwordFaas": {
        "enabled": true,
        "encryptUrl": null,
        "decryptUrl": null,
        "validateUrl": null
    },
    "whitelist": {
        "phoneEnabled": true,
        "emailEnabled": true,
        "usernameEnabled": true
    },
    "customSMSProvider": {
        "enabled": true,
        "provider": null,
        "config": null
    },
    "customDb": {
        "cahceConfig": null,
        "loggingConfig": null,
        "enabled": true,
        "mode": null,
        "connection": null,
        "scripts": [
            "string"
        ]
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://core.authing.cn/api/v2/userpools/detail' \
--header 'Authorization: Bearer token' \
--header 'x-authing-userpool-id: 59f86b4832eb28071bdd9214' \
--header 'Content-Type: application/json' \
--data-raw '{
    "frequentRegisterCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "loginFailCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "loginPasswordFailCheck": {
        "timeInterval": 0,
        "limit": 0,
        "enabled": true
    },
    "passwordUpdatePolicy": {
        "enabled": true,
        "forcedCycle": null,
        "differenceCycle": null
    },
    "changePhoneStrategy": {
        "verifyOldPhone": true
    },
    "changeEmailStrategy": {
        "verifyOldEmail": true
    },
    "qrcodeLoginStrategy": {
        "qrcodeExpiresAfter": 0,
        "ticketExpiresAfter": 0,
        "returnFullUserInfo": true,
        "allowExchangeUserInfoFromBrowser": true
    },
    "app2WxappLoginStrategy": {
        "ticketExpiresAfter": 0,
        "ticketExchangeUserInfoNeedSecret": true
    },
    "id": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "isRoot": true,
    "userId": "string",
    "logo": "string",
    "name": "string",
    "domain": "string",
    "secret": "string",
    "appSsoEnabled": true,
    "allowedOrigins": "string",
    "emailVerifiedDefault": true,
    "sendWelcomeEmail": true,
    "registerDisabled": true,
    "loginRequireEmailVerified": true,
    "description": "string",
    "jwtSecret": "string",
    "tokenExpiresAfter": 0,
    "isDeleted": true,
    "loginFailStrategy": "string",
    "userpoolTypes": null,
    "passwordStrength": 0,
    "packageType": 0,
    "defaultNamespaceId": 0,
    "systemNamespaceId": 0,
    "verifyCodeLength": 0,
    "userPoolType": "string",
    "internationalSmsConfig": null,
    "customPasswordStrength": {
        "enabled": true,
        "regex": null,
        "message": null
    },
    "passwordFaas": {
        "enabled": true,
        "encryptUrl": null,
        "decryptUrl": null,
        "validateUrl": null
    },
    "whitelist": {
        "phoneEnabled": true,
        "emailEnabled": true,
        "usernameEnabled": true
    },
    "customSMSProvider": {
        "enabled": true,
        "provider": null,
        "config": null
    },
    "customDb": {
        "cahceConfig": null,
        "loggingConfig": null,
        "enabled": true,
        "mode": null,
        "connection": null,
        "scripts": [
            "string"
        ]
    }
}'

返回响应

🟢200成功

application/json

Body

code

integer

必需

message

string

必需

data

object

必需

frequentRegisterCheck

object

必需

loginFailCheck

object

必需

loginPasswordFailCheck

object

必需

passwordUpdatePolicy

object

必需

changePhoneStrategy

object

必需

changeEmailStrategy

object

必需

qrcodeLoginStrategy

object

必需

app2WxappLoginStrategy

object

必需

string

必需

createdAt

string

必需

updatedAt

string

必需

isRoot

boolean

必需

userId

string

必需

logo

string

必需

name

string

必需

domain

string

必需

secret

string

必需

appSsoEnabled

boolean

必需

allowedOrigins

string

必需

emailVerifiedDefault

boolean

必需

sendWelcomeEmail

boolean

必需

registerDisabled

boolean

必需

loginRequireEmailVerified

boolean

必需

description

string

必需

jwtSecret

string

必需

tokenExpiresAfter

integer

必需

isDeleted

boolean

必需

loginFailStrategy

string

必需

userpoolTypes

null

必需

passwordStrength

integer

必需

packageType

integer

必需

defaultNamespaceId

integer

必需

systemNamespaceId

integer

必需

verifyCodeLength

integer

必需

userPoolType

string

必需

internationalSmsConfig

null

必需

customPasswordStrength

object

必需

passwordFaas

object

必需

whitelist

object

必需

customSMSProvider

object

必需

customDb

object

必需

示例

{
    "code": 200,
    "message": "更新成功",
    "data": {
        "frequentRegisterCheck": {
            "timeInterval": 300,
            "limit": 50,
            "enabled": false
        },
        "loginFailCheck": {
            "timeInterval": 3000,
            "limit": 50,
            "enabled": true
        },
        "loginPasswordFailCheck": {
            "timeInterval": 3000,
            "limit": 55,
            "enabled": true
        },
        "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": "59f86b4832eb28071bdd9214",
        "createdAt": "2021-09-08T02:30:36.243Z",
        "updatedAt": "2021-09-08T02:30:36.243Z",
        "isRoot": false,
        "userId": "5a597f35085a2000144a10ed",
        "logo": "https://files.authing.co/authing-console/default-userpool-logo.ico",
        "name": "测试",
        "domain": "sign",
        "secret": "eb512df21f41133ea02fdad4efeb296c",
        "appSsoEnabled": false,
        "allowedOrigins": "",
        "emailVerifiedDefault": false,
        "sendWelcomeEmail": true,
        "registerDisabled": false,
        "loginRequireEmailVerified": false,
        "description": "测试修改",
        "jwtSecret": "4ff2dc0761edd4df77c11ba32db89ca1",
        "tokenExpiresAfter": 1296000,
        "isDeleted": false,
        "loginFailStrategy": "captcha",
        "userpoolTypes": null,
        "passwordStrength": 0,
        "packageType": -1,
        "defaultNamespaceId": 2,
        "systemNamespaceId": 1,
        "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": []
        }
    }
}