查询用户OIDC配置

最近更新时间:2025-05-23 01:09:31

我的收藏

1. 接口描述

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

查询用户OIDC配置

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:DescribeUserOIDCConfig。
Version String 公共参数,本接口取值:2019-01-16。
Region String 公共参数,此参数为可选参数。

3. 输出参数

参数名称 类型 描述
ProviderType Integer 身份提供商类型。 12:用户OIDC身份提供商
示例值:11
IdentityUrl String 身份提供商URL
示例值:http://test-idp.com
IdentityKey String 签名公钥
示例值:sdg****
ClientId String 客户端id
示例值:dbw****
Status Integer 状态:0:未设置,11:已开启,2:已禁用
示例值:11
AuthorizationEndpoint String 授权请求Endpoint
示例值:http://test-endpoint.com
Scope Array of String 授权请求Scope
示例值:[ "openid" ]
ResponseType String 授权请求Response type
示例值:id_token
ResponseMode String 授权请求Response mode
示例值:form_post
MappingFiled String 映射字段名称
示例值:sub
Description String 描述
示例值:this is description
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 获取用户OIDC配置

输入示例

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

{}

输出示例

{
    "Response": {
        "Description": "描述信息",
        "ProviderType": 12,
        "IdentityUrl": "https://tencent.auth**.cn/",
        "IdentityKey": "ewogICAgImtleXMiOiBbC****",
        "ClientId": "61adcf00620c31e3d***",
        "AuthorizationEndpoint": "https://tencent.auth**.cn",
        "Scope": [
            "openid",
            "email"
        ],
        "ResponseType": "id_token",
        "ResponseMode": "form_post",
        "MappingFiled": "sub",
        "Status": 11,
        "RequestId": "e00eaca1-57b4-49e7-978d-648c5f1b9bd3"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
ResourceNotFound.IdentityNotExist 身份提供商不存在。