文档

GetOIDCProvider - 查询OIDC身份提供商信息

更新时间:

调用GetOIDCProvider查询OIDC身份提供商信息。

接口说明

使用说明

本文将提供一个示例,查询名为TestOIDCProvider的 OIDC 身份提供商信息。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
ram:GetOIDCProviderRead
  • OIDCProvider
    acs:ram::{#accountId}:oidc-provider/{#OIDCProviderName}
  • ram:OidcIssuerUrl

请求参数

名称类型必填描述示例值
OIDCProviderNamestring

OIDC 身份提供商的名称。

TestOIDCProvider

关于公共请求参数的详情,请参见公共参数

返回参数

名称类型描述示例值
object

返回结果。

RequestIdstring

请求 ID。

E5E1A300-279D-5FBD-A8CF-F4EDC20C4896
OIDCProviderobject

OIDC 身份提供商信息。

UpdateDatestring

修改时间(UTC 时间)。

2021-11-12T08:38:29Z
Descriptionstring

OIDC 身份提供商的描述。

This is a new OIDC Provider.
OIDCProviderNamestring

OIDC 身份提供商的名称。

TestOIDCProvider
CreateDatestring

创建时间(UTC 时间)。

2021-11-11T06:56:03Z
Arnstring

OIDC 身份提供商的 ARN。

acs:ram::177242285274****:oidc-provider/TestOIDCProvider
IssuerUrlstring

OIDC 身份提供商的颁发者 URL。

https://xxxxxx.example.com
Fingerprintsstring

HTTPS CA 证书的验证指纹。多个之间用半角逗号(,)分隔。

902ef2deeb3c5b13ea4c3d5193629309e231****
ClientIdsstring

客户端 ID。多个之间用半角逗号(,)分隔。

498469743454717****
GmtCreatestring

创建时间(时间戳)。

1636613763000
GmtModifiedstring

修改时间(时间戳)。

1636706309000
IssuanceLimitTimelong

允许外部 IdP 颁发 ID Token 的最早签发时间。ID Token 中的 iat 字段如果距离当前时间大于这个值则请求会被拒绝。 单位:小时。取值范围:1~168。

12

示例

正常返回示例

JSON格式

{
  "RequestId": "E5E1A300-279D-5FBD-A8CF-F4EDC20C4896",
  "OIDCProvider": {
    "UpdateDate": "2021-11-12T08:38:29Z",
    "Description": "This is a new OIDC Provider.",
    "OIDCProviderName": "TestOIDCProvider",
    "CreateDate": "2021-11-11T06:56:03Z",
    "Arn": "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl": "https://xxxxxx.example.com",
    "Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds": "498469743454717****",
    "GmtCreate": "1636613763000",
    "GmtModified": "1636706309000",
    "IssuanceLimitTime": 12
  }
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2023-07-20OpenAPI 返回结构发生变更看变更集
变更项变更内容
出参OpenAPI 返回结构发生变更
  • 本页导读 (1)
文档反馈