跳到主要内容

登录配置

管理云开发环境的登录策略配置,包括登录方式开关、短信验证配置、MFA 多因子认证及密码更新策略等。

v3.1.0+

推荐使用 tcb env login gettcb env login set 命令管理登录配置。旧版 list/create/update 子命令已废弃,将在后续版本中移除。

查询登录策略配置

查询当前环境的登录策略配置,包括各登录方式的开关状态、短信验证配置、MFA 配置和密码更新策略:

tcb env login get -e <envId>

命令参数:

参数说明
-e, --env-id <envId>环境 ID

示例:

# 查询登录策略配置
tcb env login get -e env-xxx

# 以 JSON 格式输出
tcb env login get -e env-xxx --json

输出说明:

命令会输出以下配置信息:

配置项说明
Login Config
EmailLogin邮箱登录开关
AnonymousLogin匿名登录开关
UserNameLogin用户名密码登录开关
PhoneNumberLogin手机号短信登录开关
SmsVerificationConfig
Type短信发送通道类型
Name自定义 APIs 数据源名称
Method短信发送调用方法
SmsDayLimit每日发送限额
MfaConfig
On是否开启 MFA
Sms是否开启短信 MFA
Email是否开启邮箱 MFA
RequiredBindPhone是否强制绑定手机号
PwdUpdateStrategy
FirstLoginUpdate首次登录是否强制改密
PeriodUpdate是否开启定期改密
PeriodValue定期改密周期值
PeriodType定期改密周期单位

修改登录策略配置

修改当前环境的登录策略配置。未指定的参数将保持当前值不变:

tcb env login set -e <envId> [options]

命令参数:

登录方式开关:

参数说明取值
--phone-number-login <value>手机号短信登录开关true / false
--email-login <value>邮箱登录开关true / false
--username-login <value>用户名密码登录开关true / false
--anonymous-login <value>匿名登录开关true / false

短信验证配置(SmsVerificationConfig):

参数说明
--sms-type <smsType>短信发送通道类型(如 default
--sms-name <smsName>自定义 APIs 数据源名称
--sms-method <smsMethod>短信发送调用方法
--sms-day-limit <smsDayLimit>每日发送限额(-1 不限制)

MFA 多因子认证配置(MfaConfig):

参数说明取值
--mfa-on <value>是否开启 MFATRUE / FALSE
--mfa-sms <value>是否开启短信 MFATRUE / FALSE
--mfa-email <value>是否开启邮箱 MFATRUE / FALSE
--mfa-required-bind-phone <value>是否强制绑定手机号TRUE / FALSE

密码更新策略(PwdUpdateStrategy):

参数说明取值
--first-login-update <value>首次登录是否强制改密true / false
--period-update <value>是否开启定期改密true / false
--period-value <value>定期改密周期值数字
--period-type <value>定期改密周期单位YEAR / MONTH / WEEK

示例:

# 开启匿名登录
tcb env login set -e env-xxx --anonymous-login true

# 同时配置多个登录方式
tcb env login set -e env-xxx --phone-number-login true --username-login true --anonymous-login false

# 配置密码更新策略:开启定期改密,周期为 3 个月
tcb env login set -e env-xxx --period-update true --period-value 3 --period-type MONTH

# 以 JSON 格式输出
tcb env login set -e env-xxx --anonymous-login true --json
提示
  • set 命令会先查询当前配置,未指定的参数会沿用当前配置值,不会被重置。
  • 登录方式开关的取值为小写 true/false,MFA 相关配置的取值为大写 TRUE/FALSE

旧版命令(已废弃)

注意

以下命令已废弃(DEPRECATED),请迁移至 tcb env login get / tcb env login set。旧版命令将在后续版本中移除。

查看登录方式(已废弃)

tcb env login list

列出环境配置的登录方式列表。建议使用 tcb env login get 替代。

新建登录方式(已废弃)

tcb env login create

交互式添加登录方式配置,支持微信公众平台、微信开放平台和匿名登录。

修改登录方式(已废弃)

tcb env login update

交互式修改已有的登录方式配置。建议使用 tcb env login set 替代。


命令速查

命令说明版本
tcb env login get查询登录策略配置v3.1.0+
tcb env login set修改登录策略配置v3.1.0+
tcb env login list列出登录方式(已废弃)v1+
tcb env login create添加登录方式(已废弃)v1+
tcb env login update修改登录方式(已废弃)v1+