Authing DocsDocuments
Concept
Guides
Development Integration
Application integration
Concept
Guides
Development Integration
Application integration
Old Version
Development Integration
  • Single Sign-On (SSO)
  • Login component

  • JavaScript/Node.js

    • User Authentication Module

    • Management Module

      • Management user
      • Management application
      • Management role
      • Manage resources and permissions
      • Management groups
      • Management organization
      • Management User Custom Fields
      • Management registration white list
      • Management user pool configuration
      • Management MFA
      • Management subject certification
  • Java / Kotlin

  • Python

  • C#

  • PHP

  • Go

  • Ruby
  • Android

  • iOS

  • Flutter

  • React Native
  • WeChat Mini Program
  • WeChat webpage authorization
  • Framework Integration
  • Error code
  1. Development Integration
  2. /
  3. JavaScript/Node.js
  4. /
  5. Management Module
  6. /
  7. Management registration white list

¶ WhitelistManagementClient

Update Time: 2022-05-14 09:29:46
Edit

Add a registration whitelist for your user pool, which is similar to the invitation registration rule. After you enable it, only users in the whitelist can register. Authing currently supports you to register with phone number, email, and username in whitelist.

Please follow the instructions below to use this client:

import { ManagementClient } from "authing-js-sdk";
const managementClient = new ManagementClient({
  userPoolId: "YOUR_USERPOOL_ID",
  secret: "YOUR_USERPOOL_SECRET"
});
managementClient.whitelist.list; // get register whitelist record
managementClient.whitelist.add; // add register whitelist record
managementClient.whitelist.remove; // delete register whitelist record

¶ Get whitelists

WhitelistManagementClient().list(type)

Get the whitelist records

¶ Parameter

  • type <WhitelistType> Whitelist type. Use USERNAME to represent username, Email for email address, Phone for phone number.

¶ Example

import { WhitelistType } from "authing-js-sdk";
const list = await managementClient.whitelist.list(WhitelistType.Email);

¶ Return value

  • Promise<WhiteList[]>

¶ Add whitelists

WhitelistManagementClient().add(type, list)

Add whitelists

¶ Parameter

  • type <WhitelistType> Whitelist type. Use USERNAME to represent username, Email for email address, Phone for phone number.
  • list <string[]> Whitelist list. (email is not case sensitive)

¶ Example

await managementClient.whitelist.add(WhitelistType.Email, "a@example.com");

¶ Return value

  • Promise<WhiteList[]>

¶ Remove whitelists

WhitelistManagementClient().remove(type, list)

Remove whitelists

¶ Parameter

  • type <WhitelistType> Whitelist type. Use USERNAME to represent username, Email for email address, Phone for phone number.
  • list <string[]> Whitelist list. (email is not case sensitive)

¶ Example

await managementClient.whitelist.remove(WhitelistType.Email, "a@example.com");

¶ Return value

  • Promise<WhiteList[]>

¶ Enable whitelists

WhitelistManagementClient().enable(type)

Enable whitelists.

¶ Parameter

  • type <WhitelistType> Whitelist type. Use USERNAME to represent username, Email for email address, Phone for phone number.

¶ Example

// add a whitelist

import { WhitelistType } from "authing-js-sdk"
await managementClient.whitelist.enable(WhitelistType.Email);
await managementClient.whitelist.add(WhitelistType.Email, [‘a@wxample.com’]);

// try to register an account not in whitelist

await authing.registerByEmail(email, 'b@example.com');

¶ Return value

¶ Disable whitelists

WhitelistManagementClient().disable(type)

Disable whitelists

¶ Parameter

  • type <WhitelistType> Whitelist type. Use USERNAME to represent username, Email for email address, Phone for phone number.

¶ Example

¶ Return value

Prev: Management User Custom Fields Next: Management user pool configuration
  • Get whitelists
  • Add whitelists
  • Remove whitelists
  • Enable whitelists
  • Disable whitelists

User identity management

Integrated third-party login
Mobile phone number flash check (opens new window)
Universal login form component
Custom authentication process

Enterprise internal management

Single Sign On
Multi-factor Authentication
Authority Management

Developers

Development Document
Framework Integration
Blog (opens new window)
GitHub (opens new window)
Community User Center (opens new window)

Company

400 888 2106
sales@authing.cn
16 / F, Block B, NORTH STAR CENTURY CENTER, Beijing(Total)
room 406, 4th floor, zone B, building 1, No. 200, Tianfu Fifth Street, Chengdu(branch)

Beijing ICP No.19051205-1

© Beijing Steamory Technology Co.