查询所有OIDC提供商 - ListOIDCProvidersV5
功能介绍
该接口可以用于查询所有 OpenID Connect (OIDC) 的身份提供商 (IdP) 列表。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| iam:oidcProviders:listV5 | List | oidcProvider * | - | - | - |
URI
GET /v5/oidc-providers
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| limit | 否 | Integer | 参数解释: 每页显示的条目数量。 约束限制: 不涉及。 取值范围: 取值范围为[1,200]。 默认取值: 默认为100。 |
| marker | 否 | String | 参数解释: 服务内部自动生成的分页标记,用于标记本次请求的起始位置,可从上一次分页请求响应体的next_marker获得。 约束限制: 长度为4到400个字符,只包含字母、数字、"+"、"/"、"="、"-"和"_"的字符串。 取值范围: 不涉及。 默认取值: 不涉及。 |
请求参数
无
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| oidc_providers | Array of oidc_providers objects | 参数解释: OIDC 提供商列表。 取值范围: 不涉及。 |
| page_info | page_info object | 参数解释: 分页信息。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| provider_id | String | 参数解释: OIDC 身份提供商的 ID。 取值范围: 字符串长度在 1 到 64 之间,并且只能包含:字母、数字、中划线(-)。 |
| name | String | 参数解释: OIDC 身份提供商的名称。 取值范围: 字符串长度在 1 到 64 之间,并且只能包含:字母、数字、下划线(_)、中划线(-)。 |
| description | String | 参数解释: 身份提供商描述。 取值范围: 字符串长度不超过 255,并且不能包含特定字符"@"、"#"、"%"、"&"、"<"、">"、""、"$"、"^"和"*"。 |
| url | String | 参数解释: OIDC 身份提供商的 URL。 取值范围: 字符串长度在 1 到 255 之间。 |
| urn | String | 参数解释: 统一资源名称。 取值范围: 字符串长度在 16 到 1500 之间,并且只能包含:字母、数字、字符"/"、"="、"_"、":"、"-"。 |
| client_ids | Array of strings | 参数解释: 客户端 ID 列表。 取值范围: 数组长度在 1 到 100 之间;数组元素为字符串,长度在 1 到 255 之间。 |
| thumbprints | Array of strings | 参数解释: OIDC 身份提供商的服务器证书指纹列表。 取值范围: 数组长度在 1 到 5 之间;数组元素为长度为 64 的字符串,并且只能包含字母、数字。 |
| created_at | String | 参数解释: 提供商创建时间。 取值范围: 不涉及。 |
| 参数 | 参数类型 | 描述 |
|---|---|---|
| next_marker | String | 参数解释: 如果存在,则表示还有后续的条目未显示在当前返回体中。请使用该值作为下一次请求的分页标记参数以获得下一页信息。请反复调用该接口直至该字段不存在。 取值范围: 不涉及。 |
| current_count | Integer | 参数解释: 本页返回条目数量。 取值范围: 不涉及。 |
状态码:400
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如 PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API 请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
状态码:403
| 参数 | 参数类型 | 描述 |
|---|---|---|
| error_code | String | 参数解释: 错误码,请参见错误码。 取值范围: 格式为PAP5.XXXX,例如PAP5.0012。 |
| error_msg | String | 参数解释: 错误信息,请参见错误信息。 取值范围: 不涉及。 |
| request_id | String | 参数解释: API请求的唯一标识,用于排查接口调用异常。 取值范围: 不涉及。 |
| encoded_authorization_message | String | 参数解释: 认证失败时返回的加密详细信息,用于定位认证问题。 可以通过STS5解密接口进行解密,请参见接口链接。 取值范围: 不涉及。 |
请求示例
无
响应示例
无
状态码
| 状态码 | 描述 |
|---|---|
| 200 | 请求成功。 |
| 400 | 请求体异常。 |
| 403 | 没有操作权限。 |
错误码
请参见错误码。