當您進行獲授權的 API 連線時,可以使用 API Token 來驗證自己。API Token 以前稱為 OAuth 重新整理 Token,用於交換存取 Token,並按組織授權存取。您可以從 Cloud Services 主控台 中的帳戶頁面或透過 VMware Cloud Services 產生 API Token。

Token 是使用選取英數字元的特殊演算法產生的。每個 Token 都是唯一的 65 個字元的組合。產生 Token 時,您可以確定其持續時間和範圍:
  • Token 的存留時間 (TTL) 範圍可以是幾分鐘到幾個月,也可以設定為永不過期。預設持續時間為六個月。
  • 可透過範圍控制 Token 能夠存取的組織區域,尤其是能夠存取組織中的哪個角色以及哪些服務和權限層級。

必要條件

確保 API Token 的儲存位置安全且受保護。

程序

  1. Cloud Services 主控台工具列上,按一下您的使用者名稱,然後選取我的帳戶 > API Token
  2. 按一下產生新的 API Token 連結。
  3. 輸入 Token 名稱。
  4. 指定 Token 的所需週期。
    備註: 遭到入侵時,不會到期的 Token 可能存在安全性風險。如果發生這種情況,必須撤銷 Token。
  5. 定義 Token 的範圍。您的選取項目必須基於您的使用者帳戶支援的角色。
    範圍 說明
    組織角色 組織角色決定了使用者對組織資源的存取權。
    • 為您的 API Token 選取一或多個組織角色。
    服務角色 服務角色內建在授與對 VMware Cloud services 的存取權的預先定義權限集中。
    • 使用服務名稱旁邊的箭頭圖示可展開可用於該服務的角色,然後為您的 API Token 選取一或多個服務角色。
    權限 某些服務可讓您為服務角色指派一組有限的可用權限,從而進行更精細的選擇。
    • 選取服務角色時,可用權限將顯示在表的右側。為您的 API Token 選取相關的服務權限。
    如有需要,您可以選取 所有角色,並授與 Token 存取所有組織和服務角色的權限。
    備註: 即使您為 Token 指派 所有角色存取權,此 Token 也只有您的使用者帳戶支援的存取角色。若要檢視您擁有的組織和服務角色,請在 我的帳戶頁面中選取 我的角色索引標籤。
  6. (可選) 選取 Open ID 核取方塊以擷取具有擴展使用者詳細資料的 Open ID 合規 Token。
  7. (可選) 設定電子郵件喜好設定,以便在 Token 即將到期時接收提醒。
  8. 按一下產生
  9. 將 Token 認證儲存在安全的位置,以便可以擷取這些認證以供日後使用。
    基於安全考量,在您產生 Token 之後,我們僅在 [API Token] 頁面上顯示 Token 的名稱,並不顯示 Token 認證。這表示,您將無法再透過從這個頁面複製認證來重複使用 Token。
  10. 按一下繼續
    除了 API Token 之外,您還可以使用 OAuth 應用程式來驗證您的應用程式。若要查看何時使用 OAuth 應用程式而非 API Token,請參閱 OAuth 應用程式和 API Token 之間的差異是什麼

範例: 使用 API Token 與 VMware Cloud Service API 互動

透過用 API Token 換取驗證 Token,您可以使用 API Token 與我們的 API 互動。
  1. 產生 API Token。
  2. https://console.cloud.vmware.com/csp/gateway/am/api/auth/api-tokens/authorize 執行 POST
  3. 在標頭中,加入下列要求:
    • accept: application/json
    • content type: application/x-www-form-urlencoded/
  4. 在本文中,加入 refresh_token={token value} 要求。
  5. 在您的指令碼 HTTP 呼叫中的 csp-auth-token 標頭中使用驗證 Token。