跳到主要內容

管理 API 金鑰

API 金鑰是用於驗證使用者、開發人員或對 API 叫用計畫的唯一識別碼。API 金鑰通常用於追蹤和控制介面的使用方式,以防濫用 API

API 金鑰概述

依照預設,已在 Management Console 中停用 API 金鑰。若要啟用 API 金鑰,請至設定區段。租用戶管理員可以撤銷 API 金鑰並編輯 API 金鑰設定,但若要產生或刪除 API 金鑰,您必須擁有開發人員角色。租用戶管理員會將開發人員角色指派至使用者。若您是租用戶管理員,則可以將開發人員角色指派給自己。

API 金鑰表格顯示下列關於 API 金鑰的資訊:名稱、ID、擁有者、上次更新、建立日期、到期日期和狀態。使用搜尋欄位以在前三個欄位搜尋:金鑰名稱金鑰 ID擁有者

API 金鑰狀態

API 金鑰可以有下列狀態:

  • 作用中:API 金鑰使用中。
  • 到期:已達到期日期。
  • 已撤銷:已撤銷 API 金鑰,再也無法使用。

作為管理員,您可以在 Management Console 檢閱在事件區段中註冊的 API 金鑰活動。若偵測到可疑活動,例如延伸使用特定 API 金鑰,您可以撤銷該 API 金鑰。按一下表格最右側的箭頭,以開啟詳細清單,並複製  API 金鑰的 ID。然後您可以在 API 金鑰區段中搜尋 ID,以尋找要撤銷的 API 金鑰。

若要撤銷單一 API 金鑰,按一下最右側的按鈕 ... 並選取撤銷。您只能撤銷狀態為作用中的金鑰。若要撤銷多個金鑰,選取要撤銷的金鑰左側的核取方塊,然後按一下右上角的撤銷。撤銷為不可復原的動作,已撤銷的 API 金鑰無法重新啟用。

除了撤銷,也有刪除選項。您可以從中心刪除 API 金鑰,但不可在 Management Console 進行。

啟用租用戶中的 API 金鑰

啟用 API 金鑰設定可在設定頁面上的 Management Console 中開啟。依照預設,已在 Management Console 中停用 API 金鑰。

API 金鑰的屬性
屬性 描述
啟用 API 金鑰

此開關可啟用或停用租用戶中的所有 API 金鑰。只有租用戶管理員可以啟用 API 金鑰。

變更最大 Token 到期日

變更 Token 到期值後,所有新的 Token 將有新的到期值。已存在的 API 將不會受到變更影響,而會有與之前相同的到期值。

變更每個使用者的 API 金鑰上限

此設定只會影響新的 API 金鑰。若新的 API 金鑰讓總數超過數量上限,則會拒絕建立。

請執行下列動作:

  1. Management Console 中,前往設定頁面。
  2. API 金鑰區段之下,開啟啟用 API 金鑰按鈕。
  3. 若適用,請變更變更 Token 到期上限變更每個使用者的 API 金鑰上限設定。

從中心產生 API 金鑰

您可以從中心產生 API 金鑰。開始之前,請確認滿足下列兩個要求:

  • 啟用 API 金鑰設定可在 Management Console 中開啟。
  • 租用戶管理員已將開發人員角色指派給您。

請執行下列動作:

  1. 登入租用戶,例如 https://<tenantname>.com

  2. 按一下右上角的設定檔並選取設定檔設定

  3. 選取 API 金鑰

  4. 按一下產生新的金鑰

  5. 輸入 API 金鑰說明並選取 API 金鑰到期的時間。

  6. 按一下產生

    會產生 API 金鑰。

  7. 複製 API 金鑰並存放在安全處。

建立後,可以編輯 API 金鑰的名稱。您也可以對此刪除。