云开发 CloudBase 获取登录策略

1. 接口描述

接口请求域名： tcb.tencentcloudapi.com 。

查询指定云开发环境的登录策略配置。包括手机号短信登录、邮箱登录、用户名密码登录和匿名登录方式的开启状态，同时包含短信验证码发送通道、MFA 多因子认证和密码的更新策略。

默认接口请求频率限制：20次/秒。

推荐使用 API Explorer

点击调试

API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

参数名称	必选	类型	描述
Action	是	String	公共参数，本接口取值：DescribeLoginConfig。
Version	是	String	公共参数，本接口取值：2018-06-08。
Region	是	String	公共参数，详见产品支持的地域列表。
EnvId	是	String	环境id 示例值：env-123

3. 输出参数

参数名称	类型	描述
EmailLogin	Boolean	是否开启邮箱登录方式。true 表示已开启，允许用户使用邮箱和密码进行登录；false 表示已关闭。示例值：true
AnonymousLogin	Boolean	是否开启匿名登录方式。true 表示已开启，允许用户无需注册即可以匿名身份登录；false 表示已关闭。示例值：true
UserNameLogin	Boolean	是否开启用户名密码登录方式。true 表示已开启，允许用户使用用户名和密码进行登录；false 表示已关闭。示例值：true
SmsVerificationConfig	VerificationConfig	短信验证码发送配置，包含短信发送通道类型、自定义 APIs 数据源、调用方法及每日发送限额等信息。
PhoneNumberLogin	Boolean	是否开启手机号短信登录方式。true 表示已开启，允许用户使用手机号和短信验证码进行登录和注册；false 表示已关闭。示例值：true
MfaConfig	MFALoginConfig	MFA 多因子认证登录配置，包含 MFA 开关及各验证方式（短信、邮箱、TOTP、强制绑定手机号）的启用状态。注意：此字段可能返回 null，表示取不到有效值。
PwdUpdateStrategy	PasswordUpdateLoginConfig	密码修改策略配置，包含首次登录强制修改密码开关及定期修改密码策略（周期和时间单位）。注意：此字段可能返回 null，表示取不到有效值。
RequestId	String	唯一请求 ID，由服务端生成，每次请求都会返回（若请求因其他原因未能抵达服务端，则该次请求不会获得 RequestId）。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询登录配置

输入示例

POST / HTTP/1.1
Host: tcb.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: DescribeLoginConfig
<公共请求参数>

{
    "EnvId": "env-123"
}

输出示例

{
    "Response": {
        "AnonymousLogin": true,
        "EmailLogin": true,
        "MfaConfig": {
            "Email": "FALSE",
            "On": "TRUE",
            "RequiredBindPhone": "TRUE",
            "Sms": "TRUE"
        },
        "PhoneNumberLogin": true,
        "PwdUpdateStrategy": {
            "FirstLoginUpdate": true,
            "PeriodType": "MONTH",
            "PeriodUpdate": true,
            "PeriodValue": 6
        },
        "SmsVerificationConfig": {
            "Method": "",
            "Name": "",
            "SmsDayLimit": -1,
            "Type": "default"
        },
        "UserNameLogin": true,
        "RequestId": "9f69a66b-7302-4c00-b83a-04526851dd8f"
    }
}

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

命令行工具

Tencent Cloud CLI 3.0

6. 错误码

以下仅列出了接口业务逻辑相关的错误码，其他错误码详见公共错误码。

错误码	描述
AuthFailure	CAM签名/鉴权错误。
FailedOperation	操作失败。
InvalidParameter	参数错误。
ResourceNotFound	资源不存在。
UnauthorizedOperation	未授权操作。

获取登录策略

本页目录：