全部產品
Search

搜尋本產品

    CloudSSO：GetExternalSAMLIdentityProvider - 查詢SAML身份供應商配置資訊

    文件中心

    CloudSSO：GetExternalSAMLIdentityProvider - 查詢SAML身份供應商配置資訊

    更新時間：Dec 20, 2025

    調用GetExternalSAMLIdentityProvider查詢SAML身份供應商（IdP）的配置資訊。

    介面說明

    本文將提供一個樣本，查詢目錄d-00fc2p61****下的 SAML 身份供應商的配置資訊。

    調試

    您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。

    調試

    授權資訊

    下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：

    • 操作：是指具體的許可權點。

    • 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。

    • 資源類型：是指操作中支援授權的資源類型。具體說明如下：

      • 對於必選的資源類型，用前面加 * 表示。

      • 對於不支援資源級授權的操作，用全部資源表示。

    • 條件關鍵字：是指雲產品自身定義的條件關鍵字。

    • 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。

    操作

    存取層級

    資源類型

    條件關鍵字

    關聯操作

    cloudsso:GetExternalSAMLIdentityProvider

    get

    *Directory

    acs:cloudsso:{#regionId}:{#accountId}:directory/{#DirectoryId}

    		 無 無

    請求參數

    名稱

    類型

    必填

    描述

    樣本值
    DirectoryId

    string

    是

    目錄 ID。

    d-00fc2p61****

    返回參數

    名稱

    類型

    描述

    樣本值

    object

    返回結果。

    RequestId

    string

    請求 ID。

    96D1E5FF-0301-5636-8D33-071E033CFB82
    SAMLIdentityProviderConfiguration

    object

    IdP 配置資訊。

    EntityId

    string

    IdP 標識。

    http://www.okta.com/exk3qwgtjhetR2Od****
    SSOStatus

    string

    SSO 登入的啟用狀態。取值：

    • Enabled：啟用。

    • Disabled：禁用。

    Enabled
    DirectoryId

    string

    目錄 ID。

    d-00fc2p61****
    EncodedMetadataDocument

    string

    IdP 中繼資料文檔（Base 64 編碼）。

    PD94bWwgdmVyc2lvbj0iMS4****
    CreateTime

    string

    首次配置 IdP 的時間。

    2021-11-09T09:30:13Z
    WantRequestSigned

    boolean

    在使用者訪問雲 SSO 登入頁面發起 SAML SSO 時，是否要求雲 SSO 發送簽名的 SAML 請求。取值：

    • true：要求籤名。

    • false（預設值）：不要求籤名。

    false
    UpdateTime

    string

    最近一次修改 IdP 配置的時間。

    2021-11-09T09:30:22Z
    CertificateIds

    array

    SAML 簽署憑證列表。

    string

    SAML 簽署憑證 ID。

    多個 ID 之間用半形逗號（,）分隔。

    [ "idp-c-00s6c04my7hvv1uj****" ]
    LoginUrl

    string

    IdP 的登入地址。

    https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml
    BindingType

    string

    發起 SAML 請求的 Binding 方式。取值：

    • Post: 以 Post 的方式發起 SAML 請求。

    • Redirect: 以 Redirect 的方式發起 SAML 請求。

    Post

    樣本

    正常返回樣本

    JSON格式

    {
  "RequestId": "96D1E5FF-0301-5636-8D33-071E033CFB82",
  "SAMLIdentityProviderConfiguration": {
    "EntityId": "http://www.okta.com/exk3qwgtjhetR2Od****",
    "SSOStatus": "Enabled",
    "DirectoryId": "d-00fc2p61****",
    "EncodedMetadataDocument": "PD94bWwgdmVyc2lvbj0iMS4****",
    "CreateTime": "2021-11-09T09:30:13Z",
    "WantRequestSigned": false,
    "UpdateTime": "2021-11-09T09:30:22Z",
    "CertificateIds": [
      "[ \"idp-c-00s6c04my7hvv1uj****\" ]"
    ],
    "LoginUrl": "https://dev-xxxxxx.okta.com/app/dev-xxxxxx_cloudssodemo_1/exk3qwgtjhetR2Od****/sso/saml",
    "BindingType": "Post"
  }
}

    錯誤碼

    訪問錯誤中心查看更多錯誤碼。

    變更歷史

    更多資訊，參考變更詳情。