获取三方认证源列表

最近更新时间:2026-03-19 02:07:37

我的收藏

1. 接口描述

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

查询指定云开发环境下的身份认证源列表。返回该环境已配置的所有身份认证源信息,包括第三方登录(OAuth、OIDC、SAML)、微信小程序登录、自定义登录和邮箱登录等。返回结果包含认证源基本信息、关联应用、配置状态及启用情况。若自定义登录或邮箱登录的身份源尚未创建,接口会自动追加一个默认关闭状态的身份源记录。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:GetProviders。
Version String 公共参数,本接口取值:2018-06-08。
Region String 公共参数,详见产品支持的 地域列表
EnvId String 环境 ID,用于指定需要查询配置第三方身份源的云开发环境。
示例值:env-xxx

3. 输出参数

参数名称 类型 描述
Total Integer 总数
注意:此字段可能返回 null,表示取不到有效值。
示例值:10
Data Array of Provider 三方认证源列表
注意:此字段可能返回 null,表示取不到有效值。
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 查询身份源列表

输入示例

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

{
    "EnvId": "env-123"
}

输出示例

{
    "Response": {
        "Data": [
            {
                "AutoSignUpWithProviderUser": "TRUE",
                "Config": {
                    "AuthorizationEndpoint": "https://accounts.google.com/o/oauth2/v2/auth",
                    "ClientId": "example",
                    "ClientSecret": "example",
                    "Issuer": "",
                    "JwksUri": "",
                    "RedirectUri": "",
                    "RequestParametersMap": {
                        "RegisterUserType": "externalUser"
                    },
                    "ResponseParametersMap": {
                        "Email": "email",
                        "Groups": "groups",
                        "Name": "name",
                        "PhoneNumber": "phone_number",
                        "Picture": "picture",
                        "Sub": "sub",
                        "Username": "username"
                    },
                    "ResponseType": "",
                    "SamlMetadata": "",
                    "Scope": "email openid profile",
                    "SignoutEndpoint": "",
                    "TokenEndpoint": "https://oauth2.googleapis.com/token",
                    "TokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
                    "UserinfoEndpoint": "https://www.googleapis.com/oauth2/v3/userinfo"
                },
                "Description": {
                    "Localized": [],
                    "Message": ""
                },
                "Homepage": "",
                "Id": "google",
                "Name": {
                    "Localized": [],
                    "Message": "Google"
                },
                "On": "TRUE",
                "Picture": "https://qcloudimg.tencent-cloud.cn/raw/f9131c00dcbcbccd5899a449d68da3ba.png",
                "ProviderType": "OAUTH",
                "TransparentMode": "FALSE"
            }
        ],
        "Total": 1,
        "RequestId": "490fbbcb-c5e3-4037-b851-099e636768cc"
    }
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

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

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