更新时间:2026-09-23 GMT+08:00
分享

查询指定OIDC提供商 - ShowOIDCProviderV5

功能介绍

该接口可以用于查询 OpenID Connect (OIDC) 的身份提供商 (IdP) 详情。

调试

您可以在API Explorer中调试该接口,支持自动认证鉴权。API Explorer可以自动生成SDK代码示例,并提供SDK代码示例调试功能。

授权信息

账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。

授权项

访问级别

资源类型(*为必须)

条件键

别名

依赖的授权项

iam:oidcProviders:getV5

Read

oidcProvider *

g:ResourceTag/<tag-key>

-

-

URI

GET /v5/oidc-providers/{provider_id}

表1 路径参数

参数

是否必选

参数类型

描述

provider_id

是

String

参数解释:

提供商ID。获取方式:可通过调用查询SAML提供商列表接口(ListSAMLProvidersV5)或查询OIDC提供商列表接口(ListOIDCProvidersV5)获取。

约束限制:

不涉及。

取值范围:

字符串长度在 1 到 64 之间,并且只能包含:字母、数字、中划线(-)。

默认取值:

不涉及。

请求参数

无

响应参数

状态码:200

表2 响应Body参数

参数

参数类型

描述

oidc_provider

oidc_provider object

参数解释:

OIDC 提供商。

取值范围:

不涉及。

表3 oidc_provider

参数

参数类型

描述

provider_id

String

参数解释:

OIDC 身份提供商的 ID。

取值范围:

字符串长度在 1 到 64 之间,并且只能包含:字母、数字、中划线(-)。

name

String

参数解释:

OIDC 身份提供商的名称。

取值范围:

字符串长度在 1 到 64 之间,并且只能包含:字母、数字、下划线(_)、中划线(-)。

description

String

参数解释:

身份提供商描述。

取值范围:

字符串长度不超过 255,并且不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、""、"$"、"^"和"*"。

url

String

参数解释:

OIDC 身份提供商的 URL。

取值范围:

字符串长度在 1 到 255 之间,必须以https://开头,符合URL格式规范。

urn

String

参数解释:

统一资源名称。

取值范围:

字符串长度在 16 到 1500 之间,并且只能包含:字母、数字、字符"/"、"="、"_"、":"、"-"。

client_ids

Array of strings

参数解释:

客户端 ID 列表。

取值范围:

数组长度在 1 到 100 之间;数组元素为字符串,长度在 1 到 255 之间。

thumbprints

Array of strings

参数解释:

OIDC 身份提供商的服务器证书指纹列表。

取值范围:

数组长度在 1 到 5 之间;数组元素为长度为 64 的字符串,并且只能包含字母、数字。

tags

Array of tags objects

参数解释:

自定义标签列表。

取值范围:

数组长度不涉及。

created_at

String

参数解释:

提供商创建时间。使用UTC时间格式,格式为yyyy-MM-ddTHH:mm:ss.SSSZ,例如2023-09-13T06:51:20.550Z。

取值范围:

不涉及。

表4 tags

参数

参数类型

描述

tag_key

String

参数解释:

标签键。

取值范围:

字符串长度在 1 到 64 之间,可以包含任意语种字母、数字、空格以及"_"、"."、":"、"="、"+"、"-"、"@"符号;首尾不能包含空格,且不能以"sys"开头。

tag_value

String

参数解释:

标签值。

取值范围:

字符串长度在 0 到 128 之间,可以包含任意语种字母、数字、空格以及"_"、"."、":"、"/"、"="、"+"、"-"、"@"符号,可以为空字符串。

状态码:403

表5 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见错误码。

取值范围:

格式为PAP5.XXXX,例如PAP5.0012。

error_msg

String

参数解释:

错误信息,请参见错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

API请求的唯一标识,用于排查接口调用异常。

取值范围:

不涉及。

encoded_authorization_message

String

参数解释:

认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。

取值范围:

不涉及。

状态码:404

表6 响应Body参数

参数

参数类型

描述

error_code

String

参数解释:

错误码,请参见错误码。

取值范围:

格式为PAP5.XXXX,例如 PAP5.0012。

error_msg

String

参数解释:

错误信息,请参见错误信息。

取值范围:

不涉及。

request_id

String

参数解释:

API 请求的唯一标识,用于排查接口调用异常。

取值范围:

不涉及。

请求示例

无

响应示例

状态码:200

{
  "oidc_provider" : {
    "provider_id" : "example-oidc-provider-id",
    "name" : "example_oidc_provider",
    "url" : "https://example.com/oidc/.well-known/openid-configuration",
    "urn" : "iam::123456789012:user:example-oidc-user",
    "client_ids" : [ "example-client-id-1", "example-client-id-2" ],
    "thumbprints" : [ "a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2a1b2", "c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4c3d4" ],
    "tags" : [ ],
    "created_at" : "2026-06-22T12:00:18.982Z",
    "description" : null
  }
}

状态码

状态码

描述

200

请求成功。

403

没有操作权限。

404

未找到相应的资源。

错误码

请参见错误码。

相关文档