Authing 文档文档
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
元数据
应用集成
身份自动化
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
快速开始
概念
使用指南
开发集成 V2 arrow
  • V2 文档
  • V3 文档
元数据
应用集成
身份自动化
加入 APN
开发集成
多租户(内测版)
控制台文档
多租户控制台
租户控制台
Saas 应用 Demo
旧版
开发集成
  • JavaScript SDK 索引
  • 单点登录(SSO)
  • 登录组件 (Guard)

  • 多因素认证组件(MFA)

  • JavaScript / Node.js

  • Java / Kotlin

  • Python

  • C#

  • PHP

    • 用户认证模块

    • 管理模块

      • 管理用户
      • 管理应用
      • 管理角色
      • 管理资源与权限
      • 管理分组
      • 管理组织机构
      • 管理用户自定义字段
      • 管理注册白名单
      • 管理用户池配置
      • 管理 MFA
  • Go

  • Ruby
  • Delphi
  • Android

  • iOS

  • Flutter

  • 微信小程序
  • 微信网页授权
  • React Native
  • 框架集成

  • Radius
  • 错误代码
  1. 开发集成
  2. /
  3. PHP
  4. /
  5. 管理模块
  6. /
  7. 管理用户池配置

¶ 管理用户池配置

更新时间: 2025-02-18 09:00:47
编辑

Authing 用户池配置管理模块。

请使用以下方式使用该模块:

use Authing\Mgmt\ManagementClient;

$manageClient = new ManagementClient('YOUR_USERPOOL_ID', 'YOUR_USERPOOL_SECRET');

$userpoolsManagementClient = $managementClient->userpools();
$userpoolsManagementClient->detail // 查询用户池配置
$userpoolsManagementClient->listEnv   // 获取环境变量列表
$userpoolsManagementClient->addEnv // 添加环境变量

¶ 查询用户池配置

UserPoolManagementClient->detail()

查询用户池配置

¶ 参数

无

¶ 示例

$userpool = $management->userpool()->detail();

¶ 更新用户池配置

UserPoolManagementClient->update(array $updates)

更新用户池配置

¶ 参数

  • updates <UpdateUserpoolInput>
  • updates.name <string> 用户池名称
  • updates.logo <string> 用户池 logo
  • updates.domain <string> 用户池企业应用面板二级域名
  • updates.description <string> 描述信息
  • updates.emailVerifiedDefault <boolean> 设置邮箱默认为已验证状态(用户的 emailVerified 字段为 true)
  • updates.sendWelcomeEmail <boolean> 用户注册之后是否发送欢迎邮件
  • updates.registerDisabled <boolean> 是否关闭注册,当用户池关闭注册之后,普通用户将无法注册账号,只有管理员能够手动创建账号。
  • updates.allowedOrigins <string> 安全域配置,安全域(Allowed Origins) 是允许从 JavaScript 向 Authing API 发出请求的 URL(通常与 CORS 一起使用)。 默认情况下,系统会允许你使用所有网址。 如果需要,此字段允许你输入其他来源。 你可以通过逐行分隔多个有效 URL,并在子域级别使用通配符(例如:https://*.sample.com)。 验证这些 URL 时不考虑查询字符串和哈希信息,如果带上了查询字符串和哈希信息系统会自动忽略整个域名。 如果有多条请以换行符分隔。
  • updates.whitelist <array> 用户池白名单配置
  • updates.whitelist.phoneEnabled <boolean> 是否开启手机号白名单
  • updates.whitelist.emailEnabled <boolean> 是否开启邮箱白名单
  • updates.whitelist.usernameEnabled <boolean> 是否开启用户名白名单
  • updates.tokenExpiresAfter <number> token 过期时间
  • updates.loginFailCheck <Object> 频繁登录失败限制,开启之后,在规定时间内超过次数后再次登录需要验证码。如果你的业务存在同一区域同一时间段并发登录的场景,请将此检测关闭。
  • updates.loginFailCheck.enabled <boolean> 是否开启
  • updates.loginFailCheck.timeInterval <number> 检测周期,单位为秒。
  • updates.loginFailCheck.limit <number> 同一 IP 登录失败次数达到多少次的时候会触发限制条件。
  • updates.frequentRegisterCheck <Object> 频率注册限制,开启之后同一 IP 频繁注册账号时会触发频率限制,需要等一段时间之后才能重新注册。如果你的业务存在同一区域同一时间段并发注册的场景,请将此检测关闭。
  • updates.frequentRegisterCheck.enabled <boolean> 是否开启
  • updates.frequentRegisterCheck.timeInterval <Object> 检测周期,单位为秒。
  • updates.frequentRegisterCheck.limit <Object> 同一个周期内同一 IP 注册次数达到此数目时会触发频率限制。

¶ 示例

$userpool = $management->userpool()->update(
  (new UpdateUserpoolInput())
    ->withDescription("official")
);

¶ 获取环境变量列表

UserPoolManagementClient->listEnv()

获取用户池环境变量列表。用户池配置的环境变量可以在 pipeline 场景下使用,详情请见:https://docs.authing.cn/v2/guides/pipeline/env.html

¶ 参数

无

¶ 示例

$envs = $management->userpool()->listEnv();

¶ 添加环境变量

UserPoolManagementClient->addEnv(string $key, $value)

添加环境变量

¶ 参数

  • key <string> 环境变量键
  • value <any> 环境变量值

¶ 示例

$userpool = $management->userpool()->addEnv("key", "value");

¶ 删除环境变量

UserPoolManagementClient->removeEnv($key)

删除环境变量

¶ 参数

  • key <string> 环境变量键

¶ 示例

$management->userpool()->removeEnv("key");
上一篇: 管理注册白名单 下一篇: 管理 MFA
  • 查询用户池配置
  • 更新用户池配置
  • 获取环境变量列表
  • 添加环境变量
  • 删除环境变量

用户身份管理

集成第三方登录
手机号闪验 (opens new window)
通用登录表单组件
自定义认证流程

企业内部管理

单点登录
多因素认证
权限管理

开发者

开发文档
框架集成
博客 (opens new window)
GitHub (opens new window)
社区用户中心 (opens new window)

公司

400 888 2106
sales@authing.cn
北京市朝阳区北辰世纪中心 B 座 16 层(总)
成都市高新区天府五街 200 号 1 号楼 B 区 4 楼 406 室(分)

京ICP备19051205号

beian京公网安备 11010802035968号

© 北京蒸汽记忆科技有限公司