調用CreateOIDCProvider建立OIDC身份供應商,配置阿里雲與外部身份供應商(IdP)的信任關係。
介面說明
前提條件
調用前,請提前從外部 IdP(例如:Google G Suite 或 Okta 等)擷取頒發者 URL、HTTPS CA 憑證的驗證指紋和用戶端識別碼 等資訊。
使用限制
一個阿里雲帳號中可建立的 OIDC 身份供應商最大個數:100 個。
一個 OIDC 身份供應商中的用戶端識別碼 最大個數:50 個。
一個 OIDC 身份供應商中的驗證指紋最大個數:5 個。
使用說明
本文將提供一個樣本,建立一個名為TestOIDCProvider的身份供應商,配置外部 IdP 與阿里雲的信任關係。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
調試
授權資訊
|
操作 |
存取層級 |
資源類型 |
條件關鍵字 |
關聯操作 |
|
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 |
否 |
用戶端識別碼。由外部 IdP 提供。多個之間用半形逗號(,)分隔。 格式:允許英文字母、數字、特殊字元 長度:單個用戶端識別碼 最大 128 個字元。 |
498469743454717**** |
| Fingerprints |
string |
否 |
HTTPS CA 憑證的驗證指紋。由外部 IdP 提供。多個之間用半形逗號(,)分隔。 格式:允許英文字母和數字。 長度:單個驗證指紋最大 128 個字元。 |
902ef2deeb3c5b13ea4c3d5193629309e231**** |
| IssuanceLimitTime |
integer |
否 |
允許外部 IdP 頒發 ID Token 的最早簽發時間。ID Token 中的 iat 欄位如果距離目前時間大於這個值則請求會被拒絕。 單位:小時。取值範圍:1~168。 |
6 |
關於公用請求參數的詳情,請參見公用參數。
返回參數
|
名稱 |
類型 |
描述 |
樣本值 |
|
object |
返回結果。 |
||
| RequestId |
string |
請求 ID。 |
64B11B41-636D-51E3-A39B-C8703CD2218C |
| OIDCProvider |
object |
OIDC 身份供應商資訊。 |
|
| UpdateDate |
string |
修改時間(UTC 時間)。 |
2021-11-11T06:56:03Z |
| Description |
string |
OIDC 身份供應商的描述。 |
This is an OIDC Provider. |
| OIDCProviderName |
string |
OIDC 身份供應商的名稱。 |
TestOIDCProvider |
| CreateDate |
string |
建立時間(UTC 時間)。 |
2021-11-11T06:56:03Z |
| Arn |
string |
OIDC 身份供應商的 ARN。 |
acs:ram::177242285274****:oidc-provider/TestOIDCProvider |
| IssuerUrl |
string |
頒發者 URL。 |
https://xxxxxx.example.com |
| Fingerprints |
string |
HTTPS CA 憑證的驗證指紋。 |
902ef2deeb3c5b13ea4c3d5193629309e231**** |
| ClientIds |
string |
用戶端識別碼。 |
498469743454717**** |
| GmtCreate |
string |
建立時間(時間戳記)。 |
1636613763000 |
| GmtModified |
string |
修改時間(時間戳記)。 |
1636613763000 |
| IssuanceLimitTime |
integer |
允許外部 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
}
}
錯誤碼
訪問錯誤中心查看更多錯誤碼。
變更歷史
更多資訊,參考變更詳情。