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

  • Go

  • Ruby
  • Delphi
  • Android

  • iOS

  • Flutter

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

  • Radius
  • 错误代码

¶ 登录组件(Guard)配置参数列表

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

Authing 登录组件(Guard)提供了很多高级配置,如自定义 UI,使用特定登录方式等。所有配置如下:

参数名参数说明类型是否必传默认值
target指定 Guard 表单的挂载点,接受 querySelector (opens new window) 能接受的所有参数或者 dom 元素,若未传入,Guard 会自动生成一个 div 标签放入 body 的最后面StringHTMLElement否
modeGuard 展示模式GuardMode否GuardMode.Normal
title产品名称String否Authing
logo产品 logoString否[Authing logo]
contentCss自定义 CSS 样式,如果指定了,会在 DOM 的 head 中插入一个节点。如 body {background:#6699 !important;}。String否-
loginMethods需要使用的普通登录(包括 LDAP)方式列表LoginMethods[]否[LoginMethods.PhoneCode, LoginMethods.Password]
registerMethods需要使用的注册方式RegisterMethods[]否[RegisterMethods.Email, RegisterMethods.Phone]
defaultRegisterMethod默认展示的注册方式RegisterMethods否_RegisterMethods.Email*
defaultScenes打开组件时展示的界面GuardScenes否_GuardScenes.Login*
socialConnections需要使用的社会化登录列表SocialConnections[]否[]
enterpriseConnections需要使用的企业身份源列表(不包括 LDAP),列表项值为配置的企业身份源唯一标识符,注意:企业身份源需要传入对应 appId 才能使用Array否[]
defaultLoginMethod默认显示的登录方式。可选值为 options.loginMethods 中的某一项

String

否LoginMethods.Password
autoRegister是否将注册和登录合并,合并后如果用户不存在将自动注册Boolean否false
disableRegister是否禁止注册,禁止的话会隐藏「注册」入口Boolean否false
disableResetPwd是否禁止重置密码,禁止的话会隐藏「忘记密码」入口
clickCloseableModal 模式时是否隐藏登录框右上角的关闭按钮,如果隐藏,用户将不能通过点击按钮关闭登录框Boolean否true
escCloseableModal 模式时是否可以通过键盘 ESC 键关闭登录框Boolean否true
isSSO是否是单点登录Boolean否false
appHost应用 host,如 https://xx.authing.cnString是-
qrCodeScanOptions扫码登录配置,详情请查看 QrCodeAuthenticationClient().startScanning(domId, options) (opens new window) 的 options 参数Objcect否null
lang使用语言Lang否Lang.zhCn
localesConfig语言环境配置LocalesConfig否-
apiHost自建应用的「认证地址」,如果是开启了单点登录,则应填写单点登录的「应用面板地址」String私有部署时必传[Authing 官方 api 地址]

以下为高级配置中可能用到的所有枚举值的说明:

¶ GuardMode

Guard 目前有两种展示方式 modal | normal,normal 方式会将表单插入指定的 dom 节点,适合将登录作为单独页面的场景,modal 模式会以模态框形式展示表单,适合在已有页面中弹出进行登录。默认展示方式为 normal,可通过传入 mode 参数配置展示方式:

import { AuthingGuard, GuardMode } from '@authing/native-js-ui-components'
// 引入 css 文件
import '@authing/native-js-ui-components/lib/index.min.css'

const guard = new AuthingGuard('AUTHING_APP_ID', {
  mode: GuardMode.Modal,
})

// modal 模式需要调用 show 方法才会展示表单
guard.show()

注意:native js 版本的 modal 模式需要在初始化后手动调用 guard.show() 才会展示 Guard。

通过传入 isSSO 就可开启 SSO 登录模式,Guard 会在 load 事件之后检测是否已有用户登录此应用,若有会直接触发 login 事件,方便你进行下一步操作。

keyvalue说明
Modal'modal'模态框模式
Normal'normal'正常模式

¶ LoginMethods

Guard 支持的普通登录方式

keyvalue说明
LDAP'ldap'LDAP 身份目录登录(需要配置 LDAP 服务)
AppQr'app-qrcode'APP 扫码登录(需要接入 APP 扫码登录)
Password'password'账号密码登录(包括手机号 + 密码、邮箱 + 密码、用户名 + 密码。)
PhoneCode'phone-code'手机验证码登录
WxMinQr'wechat-miniprogram-qrcode'微信 PC 小程序扫码登录
AD'ad'AD 用户目录登录

¶ RegisterMethods

Guard 支持的注册方式

keyvalue说明
Email'email'邮箱注册
Phone'phone'手机验证码注册

¶ GuardScenes

Guard 可展示的界面

keyvalue说明
Login'login'登录界面
Register'register'注册界面

¶ ResetPwdMethods

Guard 支持的重置密码方式

keyvalue说明
Email'email'邮件验证码重置
Phone'phone'手机短信验证码重置

¶ SocialConnections

Guard 支持的社会化登录方式

keyvalue说明
Qq'qq'QQ 登录
Weibo'weibo'新浪微博登录
Github'github'GitHub 登录
Google'google'Google 账号登录
WxPc'wechat:pc'微信 PC 端登录
Dingtalk'dingtalk'钉钉登录
WxWCorpQr'wechatwork:corp:qrconnect'企业微信二维码登录
WxWSPQr'wechatwork:service-provider:qrconnect'企业微信第三方应用扫码授权登录
WxWSPAuth'wechatwork:service-provider:authorization'企业微信第三方应用网页授权登录

¶ Lang

Guard 支持的语言

keyvalue说明
zhCn'zh-CN'中文
enUs'en-US'英文

¶ LocalesConfig

Guard 语言环境配置

参数说明类型默认值
defaultLang默认使用的语言LangLang.zhCn
isShowChange在 Guard 中是否显示语言切换控件booleanfalse
onChange使用 Guard 控件切换语言时的回调function(lang)-

¶ 获取帮助

请访问 Authing 论坛 (opens new window)。

  • GuardMode
  • LoginMethods
  • RegisterMethods
  • GuardScenes
  • ResetPwdMethods
  • SocialConnections
  • Lang
  • LocalesConfig
  • 获取帮助

用户身份管理

集成第三方登录
手机号闪验 (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号

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