¶ 管理注册白名单

更新时间: 2024-10-10 07:28:40

为你的用户池配置一个注册白名单，类似于邀请注册规则，开启后，只有白名单里的用户才能进行注册。 Authing 目前支持的白名单方式有手机号、邮箱、用户名。

¶ 获取白名单记录

获取白名单记录

def list(self, type)

¶ 参数

type <str> 白名单类型，USERNAME 为用户名、EMAIL 为邮箱、PHONE 为手机号

¶ 示例

management.whiteList.list("USERNAME")

¶ 示例数据

[{
	"value": "xx2",
	"createdAt": "2021-09-17T06:14:52+00:00",
	"updatedAt": "2021-09-17T06:14:52+00:00"
}, {
	"value": "xx2x",
	"createdAt": "2021-09-17T06:15:26+00:00",
	"updatedAt": "2021-09-17T06:15:26+00:00"
}]

¶ 添加白名单

添加白名单

def add(self, type, list)

¶ 参数

type <str> 白名单类型，USERNAME 为用户名、EMAIL 为邮箱、PHONE 为手机号
list <list> 白名单列表，请注意邮箱不区分大小写

¶ 示例

management.whiteList.add("USERNAME", ["xx2x"])

¶ 示例数据

[{
	"value": "xx2",
	"createdAt": "2021-09-17T06:14:52+00:00",
	"updatedAt": "2021-09-17T06:14:52+00:00"
}, {
	"value": "xx2x",
	"createdAt": "2021-09-17T06:15:26+00:00",
	"updatedAt": "2021-09-17T06:15:26+00:00"
}]

¶ 移除白名单

移除白名单

def remove(self, type, list)

¶ 参数

type <str> 白名单类型，USERNAME 为用户名、EMAIL 为邮箱、PHONE 为手机号
list <list> 白名单列表，请注意邮箱不区分大小写

¶ 示例

management.whiteList.remove("USERNAME",["xx"])

¶ 示例数据

[{
	"value": "xx2",
	"createdAt": "2021-09-17T06:14:52+00:00",
	"updatedAt": "2021-09-17T06:14:52+00:00"
}, {
	"value": "xx2x",
	"createdAt": "2021-09-17T06:15:26+00:00",
	"updatedAt": "2021-09-17T06:15:26+00:00"
}]

¶ 开启白名单

开启白名单

def enable_white_list(self, type)

¶ 参数

type <str> 白名单类型，USERNAME 为用户名、EMAIL 为邮箱、PHONE 为手机号

¶ 示例

management.whiteList.enable_white_list("USERNAME")

¶ 示例数据

{
  "domain": "n1s8",
  "whitelist": {
    "phoneEnabled": true,
    "usernameEnabled": true,
    "emailEnabled": false
  },
  "verifyCodeLength": 4,
  "qrcodeLoginStrategy": {
    "qrcodeExpiresAfter": 120,
    "ticketExpiresAfter": 300,
    "returnFullUserInfo": false,
    "allowExchangeUserInfoFromBrowser": true
  },
  "updatedAt": "2021-09-08T05:42:22+00:00",
  "logo": "https://files.authing.co/authing-console/login_logo.svg",
  "frequentRegisterCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "id": "61384d3e302f1f769c5a",
  "isDeleted": false,
  "appSsoEnabled": false,
  "loginPasswordFailCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "changeEmailStrategy": {
    "verifyOldEmail": true
  },
  "useCustomUserStore": false,
  "userpoolTypes": null,
  "jwtSecret": "1fb9f7fea152ce5b1a9af0fe18c56",
  "app2WxappLoginStrategy": {
    "ticketExchangeUserInfoNeedSecret": false,
    "ticketExpriresAfter": null
  },
  "emailVerifiedDefault": false,
  "secret": "ff053c05e4fb66a560556ec2cb715",
  "packageType": -1,
  "createdAt": "2021-09-08T05:42:22+00:00",
  "customSMSProvider": {
    "config": null,
    "enabled": false,
    "provider": null
  },
  "allowedOrigins": "",
  "description": "",
  "changePhoneStrategy": {
    "verifyOldPhone": true
  },
  "sendWelcomeEmail": true,
  "loginFailCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "loginFailStrategy": "captcha",
  "name": "newSDK",
  "registerDisabled": false,
  "tokenExpiresAfter": 1296000,
  "loginRequireEmailVerified": false,
  "showWxQRCodeWhenRegisterDisabled": null
}

¶ 关闭白名单

关闭白名单

def disable_white_list(self, type)

¶ 参数

type <str> 白名单类型，USERNAME 为用户名、EMAIL 为邮箱、PHONE 为手机号

¶ 示例

management.whiteList.disable_white_list("USERNAME")

¶ 示例数据

{
  "domain": "n1s8",
  "whitelist": {
    "phoneEnabled": true,
    "usernameEnabled": false,
    "emailEnabled": false
  },
  "verifyCodeLength": 4,
  "qrcodeLoginStrategy": {
    "qrcodeExpiresAfter": 120,
    "ticketExpiresAfter": 300,
    "returnFullUserInfo": false,
    "allowExchangeUserInfoFromBrowser": true
  },
  "updatedAt": "2021-09-08T05:42:22+00:00",
  "logo": "https://files.authing.co/authing-console/login_logo.svg",
  "frequentRegisterCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "id": "61384d3e302f1f769c5a",
  "isDeleted": false,
  "appSsoEnabled": false,
  "loginPasswordFailCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "changeEmailStrategy": {
    "verifyOldEmail": true
  },
  "useCustomUserStore": false,
  "userpoolTypes": null,
  "jwtSecret": "1fb9f7fea152ce5b1a9af0fe18c56",
  "app2WxappLoginStrategy": {
    "ticketExchangeUserInfoNeedSecret": false,
    "ticketExpriresAfter": null
  },
  "emailVerifiedDefault": false,
  "secret": "ff053c05e4fb66a560556ec2cb715",
  "packageType": -1,
  "createdAt": "2021-09-08T05:42:22+00:00",
  "customSMSProvider": {
    "config": null,
    "enabled": false,
    "provider": null
  },
  "allowedOrigins": "",
  "description": "",
  "changePhoneStrategy": {
    "verifyOldPhone": true
  },
  "sendWelcomeEmail": true,
  "loginFailCheck": {
    "timeInterval": 300,
    "enabled": false,
    "limit": 50
  },
  "loginFailStrategy": "captcha",
  "name": "newSDK",
  "registerDisabled": false,
  "tokenExpiresAfter": 1296000,
  "loginRequireEmailVerified": false,
  "showWxQRCodeWhenRegisterDisabled": null
}