1. 接口描述
接口请求域名： tcb.tencentcloudapi.com 。
修改指定云开发环境的登录策略配置。支持开启或关闭手机号短信登录、邮箱登录、用户名密码登录和匿名登录，同时可配置短信验证码发送通道、MFA 多因子认证和密码更新策略。
修改后立即生效，影响该环境下所有终端用户的登录行为。
默认接口请求频率限制：20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见 公共请求参数。
| 参数名称 | 必选 | 类型 | 描述 |
|---|---|---|---|
| Action | 是 | String | 公共参数，本接口取值：ModifyLoginConfig。 |
| Version | 是 | String | 公共参数，本接口取值：2018-06-08。 |
| Region | 是 | String | 公共参数，详见产品支持的 地域列表。 |
| EnvId | 是 | String | 环境 ID，用于指定需要修改登录策略的云开发环境。 示例值：env-123 |
| PhoneNumberLogin | 是 | Boolean | 手机号短信登录开关。设置为 true 开启手机号短信登录，允许用户使用手机号和短信验证码进行登录和注册；设置为 false 关闭手机号短信登录。 示例值：true |
| EmailLogin | 是 | Boolean | 邮箱登录开关。设置为 true 开启邮箱登录，允许用户使用邮箱和密码进行登录和注册；设置为 false 关闭邮箱登录。 示例值：true |
| UserNameLogin | 是 | Boolean | 用户名密码登录开关。设置为 true 开启用户名密码登录，允许用户使用用户名和密码进行登录和注册；设置为 false 关闭用户名密码登录。 示例值：false |
| AnonymousLogin | 是 | Boolean | 匿名登录开关。设置为 true 开启匿名登录，允许用户无需注册即可以匿名身份访问应用；设置为 false 关闭匿名登录。 示例值：false |
| SmsVerificationConfig | 否 | VerificationConfig | 短信验证码发送配置，用于设置短信验证码的发送通道类型和日发送限额。不传则不修改当前配置。 |
| MfaConfig | 否 | MFALoginConfig | MFA 多因子认证登录配置，用于设置多因子认证开关及验证方式（短信、邮箱、TOTP、强制绑定手机号）。不传则不修改当前配置。 |
| PwdUpdateStrategy | 否 | PasswordUpdateLoginConfig | 密码更新策略配置，用于设置首次登录强制修改密码和定期强制修改密码策略。不传则不修改当前配置。 |
3. 输出参数
| 参数名称 | 类型 | 描述 |
|---|---|---|
| RequestId | String | 唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改环境登录配置
使用默认云开发短信包发送登录短信
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoginConfig
<公共请求参数>
{
"EnvId": "env-123",
"PhoneNumberLogin": true,
"EmailLogin": true,
"UserNameLogin": false,
"AnonymousLogin": false,
"SmsVerificationConfig": {
"Type": "default",
"SmsDayLimit": 30
},
"MfaConfig": {
"On": "TRUE",
"Sms": "TRUE",
"Email": "FALSE",
"RequiredBindPhone": "TRUE"
},
"PwdUpdateStrategy": {
"FirstLoginUpdate": true,
"PeriodUpdate": true,
"PeriodValue": 6,
"PeriodType": "MONTH"
}
}输出示例
{
"Response": {
"RequestId": "70b8908d-5c99-4a20-be23-f84aff0bfd37"
}
}示例2 修改登录配置
使用自定义apis发送登录短信
输入示例
POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifyLoginConfig
<公共请求参数>
{
"EnvId": "env-123",
"PhoneNumberLogin": true,
"EmailLogin": true,
"UserNameLogin": false,
"AnonymousLogin": false,
"SmsVerificationConfig": {
"Type": "apis",
"Name": "method_53978f9f96a35",
"Method": "SendVerificationCode",
"SmsDayLimit": 20
},
"MfaConfig": {
"On": "TRUE",
"Sms": "TRUE",
"Email": "FALSE",
"RequiredBindPhone": "TRUE"
},
"PwdUpdateStrategy": {
"FirstLoginUpdate": true,
"PeriodUpdate": true,
"PeriodValue": 6,
"PeriodType": "MONTH"
}
}输出示例
{
"Response": {
"RequestId": "26d3461b-b116-4862-bbaf-6233d2922aca"
}
}5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台，方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况，并自动生成各语言版本的 API 代码，也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集（SDK），支持多种编程语言，能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: CNB, GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: CNB, GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码，其他错误码详见 公共错误码。
| 错误码 | 描述 |
|---|---|
| AuthFailure | CAM签名/鉴权错误。 |
| FailedOperation | 操作失败。 |
| InvalidParameter | 参数错误。 |
| InvalidParameterValue | 参数取值错误。 |
| ResourceNotFound | 资源不存在。 |
| UnauthorizedOperation | 未授权操作。 |
