調用CreateOIDCProvider創建OIDC身份提供商,配置阿里云與外部身份提供商(IdP)的信任關系。
接口說明
調試
您可以在OpenAPI Explorer中直接運行該接口,免去您計算簽名的困擾。運行成功后,OpenAPI Explorer可以自動生成SDK代碼示例。
授權信息
下表是API對應的授權信息,可以在RAM權限策略語句的Action
元素中使用,用來給RAM用戶或RAM角色授予調用此API的權限。具體說明如下:
- 操作:是指具體的權限點。
- 訪問級別:是指每個操作的訪問級別,取值為寫入(Write)、讀取(Read)或列出(List)。
- 資源類型:是指操作中支持授權的資源類型。具體說明如下:
- 對于必選的資源類型,用背景高亮的方式表示。
- 對于不支持資源級授權的操作,用
全部資源
表示。
- 條件關鍵字:是指云產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他權限。操作者必須同時具備關聯操作的權限,操作才能成功。
操作 | 訪問級別 | 資源類型 | 條件關鍵字 | 關聯操作 |
---|---|---|---|---|
ram:CreateOIDCProvider | create | *全部資源 * |
| 無 |
請求參數
名稱 | 類型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
OIDCProviderName | string | 是 | OIDC 身份提供商的名稱。 格式:允許英文字母、數字、特殊字符 長度:最大 128 個字符。 | TestOIDCProvider |
IssuerUrl | string | 是 | 頒發者 URL。由外部 IdP 提供。同一個阿里云賬號下必須唯一。 格式:該 URL 必須以 長度:最大 255 個字符。 | https://xxxxxx.example.com |
Description | string | 否 | OIDC 身份提供商的描述。 長度:最大 256 個字符。 | This is an OIDC Provider. |
ClientIds | string | 否 | 客戶端 ID。由外部 IdP 提供。多個之間用半角逗號(,)分隔。 格式:允許英文字母、數字、特殊字符 長度:單個客戶端 ID 最大 64 個字符。 | 498469743454717**** |
Fingerprints | string | 否 | HTTPS CA 證書的驗證指紋。由外部 IdP 提供。多個之間用半角逗號(,)分隔。 格式:允許英文字母和數字。 長度:單個驗證指紋最大 40 個字符。 | 902ef2deeb3c5b13ea4c3d5193629309e231**** |
IssuanceLimitTime | long | 否 | 允許外部 IdP 頒發 ID Token 的最早簽發時間。ID Token 中的 iat 字段如果距離當前時間大于這個值則請求會被拒絕。 單位:小時。取值范圍:1~168。 | 6 |
關于公共請求參數的詳情,請參見公共參數。
返回參數
示例
正常返回示例
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://xxxxxx.example.com",
"Fingerprints": "902ef2deeb3c5b13ea4c3d5193629309e231****",
"ClientIds": "498469743454717****",
"GmtCreate": "1636613763000",
"GmtModified": "1636613763000",
"IssuanceLimitTime": 6
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
變更時間 | 變更內容概要 | 操作 |
---|---|---|
2024-08-14 | OpenAPI 描述信息更新 | 查看變更詳情 |
2023-07-20 | OpenAPI 入參發生變更、OpenAPI 返回結構發生變更 | 查看變更詳情 |