调用CreateOIDCProvider创建OIDC身份提供商,配置阿里云与外部身份提供商(IdP)的信任关系。

前提条件

调用前,请提前从外部IdP(例如:Google G Suite或Okta等)获取颁发者URL、HTTPS CA证书的验证指纹和客户端ID等信息。

使用限制

  • 一个阿里云账号中可创建的OIDC身份提供商最大个数:100个。
  • 一个OIDC身份提供商中的客户端ID最大个数:20个。
  • 一个OIDC身份提供商中的验证指纹最大个数:5个。

使用说明

本文将提供一个示例,创建一个名为TestOIDCProvider的身份提供商,配置外部IdP(Okta)与阿里云的信任关系。

调试

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

请求参数

名称 类型 是否必选 示例值 描述
Action String CreateOIDCProvider

要执行的操作。取值:CreateOIDCProvider

OIDCProviderName String TestOIDCProvider

OIDC身份提供商的名称。

格式:允许英文字母、数字、特殊字符.-_,不能以特殊字符.-_开头或结尾。

长度:最大128个字符。

IssuerUrl String https://dev-xxxxxx.okta.com

颁发者URL。由外部IdP提供。同一个阿里云账号下必须唯一。

格式:该URL必须以https开头,符合标准URL格式,不允许带有query参数(以?标识)、fragment片段(以#标识)和登录信息(以@标识)。

长度:最大255个字符。

Description String This is an OIDC Provider.

OIDC身份提供商的描述。

长度:最大256个字符。

ClientIds String 498469743454717****

客户端ID。由外部IdP提供。多个之间用半角逗号(,)分隔。

格式:允许英文字母、数字、特殊字符.-_,不能以特殊字符.-_开头或结尾。

长度:单个客户端ID最大64个字符。

Fingerprints String 902ef2deeb3c5b13ea4c3d5193629309e231****

HTTPS CA证书的验证指纹。由外部IdP提供。多个之间用半角逗号(,)分隔。

格式:允许英文字母和数字。

长度:单个验证指纹最大40个字符。

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

返回数据

名称 类型 示例值 描述
RequestId String 64B11B41-636D-51E3-A39B-C8703CD2218C

请求ID。

OIDCProvider Object

OIDC身份提供商信息。

UpdateDate String 2021-11-11T06:56:03Z

修改时间(UTC时间)。

Description String This is an OIDC Provider.

OIDC身份提供商的描述。

OIDCProviderName String TestOIDCProvider

OIDC身份提供商的名称。

CreateDate String 2021-11-11T06:56:03Z

创建时间(UTC时间)。

Arn String acs:ram::177242285274****:oidc-provider/TestOIDCProvider

OIDC身份提供商的ARN。

IssuerUrl String https://dev-xxxxxx.okta.com

颁发者URL。

Fingerprints String 902ef2deeb3c5b13ea4c3d5193629309e231****

HTTPS CA证书的验证指纹。

ClientIds String 498469743454717****

客户端ID。

GmtCreate String 1636613763000

创建时间(时间戳)。

GmtModified String 1636613763000

修改时间(时间戳)。

示例

请求示例

https://[Endpoint]/?Action=CreateOIDCProvider
&OIDCProviderName=TestOIDCProvider
&IssuerUrl=https://dev-xxxxxx.okta.com
&Description=This is an OIDC Provider.
&ClientIds=498469743454717****
&Fingerprints=902ef2deeb3c5b13ea4c3d5193629309e231****
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<CreateOIDCProviderResponse>
    <RequestId>64B11B41-636D-51E3-A39B-C8703CD2218C</RequestId>
    <OIDCProvider>
        <UpdateDate>2021-11-11T06:56:03Z</UpdateDate>
        <Description>This is an OIDC Provider.</Description>
        <OIDCProviderName>TestOIDCProvider</OIDCProviderName>
        <CreateDate>2021-11-11T06:56:03Z</CreateDate>
        <Arn>acs:ram::177242285274****:oidc-provider/TestOIDCProvider</Arn>
        <IssuerUrl>https://dev-xxxxxx.okta.com</IssuerUrl>
        <Fingerprints>902ef2deeb3c5b13ea4c3d5193629309e231****</Fingerprints>
        <ClientIds>498469743454717****</ClientIds>
        <GmtCreate>1636613763000</GmtCreate>
        <GmtModified>1636613763000</GmtModified>
    </OIDCProvider>
</CreateOIDCProviderResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "64B11B41-636D-51E3-A39B-C8703CD2218C",
  "OIDCProvider" : {
    "UpdateDate" : "2021-11-11T06:56:03Z",
    "Description" : "This is an OIDC Provider.",
    "OIDCProviderName" : "TestOIDCProvider",
    "CreateDate" : "2021-11-11T06:56:03Z",
    "Arn" : "acs:ram::177242285274****:oidc-provider/TestOIDCProvider",
    "IssuerUrl" : "https://dev-xxxxxx.okta.com",
    "Fingerprints" : "902ef2deeb3c5b13ea4c3d5193629309e231****",
    "ClientIds" : "498469743454717****",
    "GmtCreate" : "1636613763000",
    "GmtModified" : "1636613763000"
  }
}

错误码

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