tcb env login set
Updates the login policy of the current environment. Fields you do not pass keep their current values.
Usage
tcb env login set -e <envId> [options]
Flags
Login method toggles:
| Flag | Required | Description | Values |
|---|---|---|---|
--phone-number-login <value> | No | Phone number SMS login toggle | true / false |
--email-login <value> | No | Email login toggle | true / false |
--username-login <value> | No | Username-password login toggle | true / false |
--anonymous-login <value> | No | Anonymous login toggle | true / false |
SMS verification (SmsVerificationConfig):
| Flag | Required | Description | Values |
|---|---|---|---|
--sms-type <smsType> | No | SMS channel type (for example default) | — |
--sms-name <smsName> | No | Custom APIs data source name | — |
--sms-method <smsMethod> | No | SMS sending method | — |
--sms-day-limit <smsDayLimit> | No | Daily sending limit (-1 for unlimited) | Number |
MFA (MfaConfig):
| Flag | Required | Description | Values |
|---|---|---|---|
--mfa-on <value> | No | Enable MFA | TRUE / FALSE |
--mfa-sms <value> | No | Enable SMS MFA | TRUE / FALSE |
--mfa-email <value> | No | Enable email MFA | TRUE / FALSE |
--mfa-required-bind-phone <value> | No | Require phone binding | TRUE / FALSE |
Password update policy (PwdUpdateStrategy):
| Flag | Required | Description | Values |
|---|---|---|---|
--first-login-update <value> | No | Force password change on first login | true / false |
--period-update <value> | No | Enable periodic password change | true / false |
--period-value <value> | No | Password change period value | Number |
--period-type <value> | No | Password change period unit | YEAR / MONTH / WEEK |
Example
# Enable anonymous login
tcb env login set -e env-xxx --anonymous-login true
# Configure multiple login methods at once
tcb env login set -e env-xxx --phone-number-login true --username-login true --anonymous-login false
# Enable periodic password change every 3 months
tcb env login set -e env-xxx --period-update true --period-value 3 --period-type MONTH
# Output in JSON format
tcb env login set -e env-xxx --anonymous-login true --json
Tip
- The
setcommand reads the current configuration first, so fields you do not pass keep their current values. - Login method toggles take lowercase
true/false; MFA settings take uppercaseTRUE/FALSE.
Versions
tcb env login set has been available since v3.1.0 and replaces the deprecated tcb env login create / tcb env login update.
Related commands
- Show the login policy: current configuration
- Authentication: log in to a Tencent Cloud account to authorize CLI operations