Skip to main content
此產品有較新版本可以使用。
本繁體中文版使用機器翻譯，譯文僅供參考，若與英文版本牴觸，應以英文版本為準。

如果啟用單一登入，請使用 StorageGRID API（PingFederate）

PDF

如果您擁有"${post_edited_translations.segment}"並使用 PingFederate 作為 SSO 供應商，則必須發出一系列 API 請求，以取得對 Grid Management API 或 Tenant Management API 有效的驗證權杖。

如果啟用了單一登入，請登入 API。

如果您使用 PingFederate 作為 SSO 身分供應商，則適用以下說明。

開始之前

  • 您知道屬於 StorageGRID 使用者群組的聯合使用者的 SSO 使用者名稱和密碼。

  • 如果您想存取租戶管理 API，您需要知道租戶帳戶 ID。

關於此任務

若要取得驗證令牌，您可以使用下列範例之一：

  • The storagegrid-ssoauth.py Python 指令碼位於 StorageGRID 安裝檔案目錄中，(`./rpms`適用於 RHEL， `./debs`適用於 Ubuntu 或 Debian，以及 `./vsphere`適用於 VMware）。

  • curl 請求的工作流程範例。

    如果您執行 curl 工作流程的速度太慢，該工作流程可能會逾時。您可能會看到錯誤： A valid SubjectConfirmation was not found on this Response。

    註 ${post_edited_translations.segment}

    如果遇到 URL 編碼問題，您可能會看到以下錯誤： Unsupported SAML version。

步驟

  1. 請選擇以下其中一種方法來取得驗證權杖：

    • 使用 storagegrid-ssoauth.py Python 指令碼。前往步驟 2。

    • 使用 curl 請求。前往步驟 3。

  2. 如果您想使用該 `storagegrid-ssoauth.py`指令碼，請將指令碼傳遞給 Python 解譯器並執行該指令碼。

    ${post_edited_translations.segment}

    • SSO 方法。您可以輸入 "pingfederate" 的任何變體（PINGFEDERATE、pingfederate 等）。

    • SSO 使用者名稱

    • 安裝 StorageGRID 的網域。此欄位不用於 PingFederate。您可以將其保留空白，或輸入任何值。

    • ${post_edited_translations.segment}

    • 如果您想存取租戶管理 API，則需要租戶帳戶 ID。

      Ping Federate 的 SSO 驗證指令碼

    StorageGRID 授權權杖已在輸出中提供。現在，您可以像未使用 SSO 時使用 API 一樣，使用此權杖發出其他請求。

  3. 如果要使用 curl 請求，請依照下列步驟操作。

    1. 聲明登入所需的變數。

      export SAMLUSER='my-sso-username'
export SAMLPASSWORD='my-password'
export TENANTACCOUNTID='12345'
export STORAGEGRID_ADDRESS='storagegrid.example.com'
      註 若要存取 Grid Management API，請使用 0 作為 TENANTACCOUNTID。

    2. 若要接收已簽署的驗證 URL，請向 /api/v3/authorize-saml 發出 POST 要求，並從回應中移除額外的 JSON 編碼。

      此範例顯示針對 TENANTACCOUNTID 的已簽署驗證 URL 的 POST 要求。結果將傳遞至 python -m json.tool 以移除 JSON 編碼。

      curl -X POST "https://$STORAGEGRID_ADDRESS/api/v3/authorize-saml" \
  -H "accept: application/json" -H  "Content-Type: application/json" \
  --data "{\"accountId\": \"$TENANTACCOUNTID\"}" | python -m json.tool

      此範例的回應包含一個經過 URL 編碼的簽章 URL，但不包含額外的 JSON 編碼階層。

      {
    "apiVersion": "3.0",
    "data": "https://my-pf-baseurl/idp/SSO.saml2?...",
    "responseTime": "2018-11-06T16:30:23.355Z",
    "status": "success"
}

    3. 儲存回應中的 SAMLRequest，以便在後續命令中使用。

      export SAMLREQUEST="https://my-pf-baseurl/idp/SSO.saml2?..."

    4. 匯出回應和 Cookie，並輸出回應：

      RESPONSE=$(curl -c - "$SAMLREQUEST")
      echo "$RESPONSE" | grep 'input type="hidden" name="pf.adapterId" id="pf.adapterId"'

    5. 匯出「pf.adapterId」值，並輸出回應：

      export ADAPTER='myAdapter'
      echo "$RESPONSE" | grep 'base'

    6. ${post_edited_translations.segment}

      export BASEURL='https://my-pf-baseurl'
      echo "$RESPONSE" | grep 'form method="POST"'

    7. 匯出「行動」值：

      export SSOPING='/idp/.../resumeSAML20/idp/SSO.ping'

    8. 傳送 Cookie 及憑證：

      curl -b <(echo "$RESPONSE") -X POST "$BASEURL$SSOPING" \
--data "pf.username=$SAMLUSER&pf.pass=$SAMLPASSWORD&pf.ok=clicked&pf.cancel=&pf.adapterId=$ADAPTER" --include

    9. 儲存隱藏欄位中的 SAMLResponse 值：

      export SAMLResponse='PHNhbWxwOlJlc3BvbnN...1scDpSZXNwb25zZT4='

    10. 使用已儲存的 SAMLResponse，向 StorageGRID 發出 /api/saml-response 請求以產生 StorageGRID 驗證權杖。

      對於 RelayState，請使用租戶帳戶 ID，或者如果您想要登入 Grid Management API，請使用 0。

      curl -X POST "https://$STORAGEGRID_ADDRESS:443/api/saml-response" \
  -H "accept: application/json" \
  --data-urlencode "SAMLResponse=$SAMLResponse" \
  --data-urlencode "RelayState=$TENANTACCOUNTID" \
  | python -m json.tool

      回應包含驗證令牌。

    {
    "apiVersion": "3.0",
    "data": "56eb07bf-21f6-40b7-af0b-5c6cacfb25e7",
    "responseTime": "2018-11-07T21:32:53.486Z",
    "status": "success"
}

    1. 將回應中的驗證權杖儲存為 MYTOKEN。

      export MYTOKEN="56eb07bf-21f6-40b7-af0b-5c6cacfb25e7"

      現在您可以使用 MYTOKEN 來處理其他請求，就像未使用 SSO 時使用 API 一樣。

如果啟用了單一登入，請登出 API。

如果已啟用單一登入 （SSO），您必須發出一系列 API 要求，以登出 Grid Management API 或 Tenant Management API。如果您使用 PingFederate 作為 SSO 身分識別供應商，則適用這些說明

關於此任務

如有需要，您可以透過組織的單一登出頁面登出，從而退出 StorageGRID API。或者，您也可以從 StorageGRID 觸發單一登出 （SLO），這需要有效的 StorageGRID 持有者權杖。

步驟

  1. 若要產生已簽署的登出請求，請將 Cookie "sso=true" 傳遞給 SLO API：

    curl -k -X DELETE "https://$STORAGEGRID_ADDRESS/api/v3/authorize" \
-H "accept: application/json" \
-H "Authorization: Bearer $MYTOKEN" \
--cookie "sso=true" \
| python -m json.tool

    傳回一個登出 URL：

    {
    "apiVersion": "3.0",
    "data": "https://my-ping-url/idp/SLO.saml2?SAMLRequest=fZDNboMwEIRfhZ...HcQ%3D%3D",
    "responseTime": "2021-10-12T22:20:30.839Z",
    "status": "success"
}

  2. 儲存登出 URL。

    export LOGOUT_REQUEST='https://my-ping-url/idp/SLO.saml2?SAMLRequest=fZDNboMwEIRfhZ...HcQ%3D%3D'

  3. ${post_edited_translations.segment}

    curl --include "$LOGOUT_REQUEST"

    返回 302 回應。重新導向位置不適用於僅透過 API 進行的登出。

    HTTP/1.1 302 Found
Location: https://$STORAGEGRID_ADDRESS:443/api/saml-logout?SAMLResponse=fVLLasMwEPwVo7ss%...%23rsa-sha256
Set-Cookie: PF=QoKs...SgCC; Path=/; Secure; HttpOnly; SameSite=None

  4. ${post_edited_translations.segment}

    刪除 StorageGRID bearer token 的運作方式與沒有 SSO 時相同。如果未提供 `Cookie "sso=true"，使用者將從 StorageGRID 登出，而不影響 SSO 狀態。

    curl -X DELETE "https://$STORAGEGRID_ADDRESS/api/v3/authorize" \
-H "accept: application/json" \
-H "Authorization: Bearer $MYTOKEN" \
--include

    A 204 No Content 回應表示使用者現在已登出。

    HTTP/1.1 204 No Content