檢視次數:
秘訣
秘訣
本文說明如何為舊版帳戶建立 API 金鑰。
如果您使用的是新的 Trend Micro Cloud One 帳戶，請參閱 管理 API 金鑰。
您可以在建立 API 金鑰後隨時修改其屬性。

重置密鑰

使用 APIKeysApi 物件為現有的 API 金鑰生成新的密鑰。例如，在定期更換 API 金鑰時重置密鑰。一旦替換，先前的密鑰將不再被 Server & Workload Security保護 認證。
當您重置密鑰時，返回的 API 金鑰在 secret_key（Python）或 secretKey（JavaScript）屬性中包含新的密鑰。對於 Java，您可以使用返回的 ApiKey 物件的 getSecretKey 方法。
APIKeysApi 類別提供 replace_api_secret_key 函數（在 JavaScript 和 Java 中為 replaceApiSecretKey），該函數將 API 金鑰的 ID 作為參數。以下範例為現有的 API 金鑰創建一個新的密鑰。
檢視來源
# Reset the key
api_keys_api = api.APIKeysApi(api.ApiClient(configuration))
return api_keys_api.replace_api_secret_key(key_id, api_version)
另請參閱 API 參考中的 生成 API 密鑰。

在建立後控制 API 金鑰存取

在您建立 API 金鑰後，您仍然可以控制 API 金鑰對 Server & Workload Security保護 的存取：
  • Modify access rights: 修改與 API 金鑰關聯的角色或將 API 金鑰關聯到不同的角色。（另請參閱 使用角色控制存取。）
  • Revoke access: 您可以選擇鎖定金鑰以暫時撤銷存取權，或刪除 API 金鑰以永久撤銷存取權。
要修改 API 金鑰，請建立一個 ApiKey 物件並設定您想要更改的屬性值。然後，使用 APIKeysApi 類別在 Server & Workload Security保護 上修改 API 金鑰。
以下範例程式碼會更改與 API 金鑰相關聯的角色。
檢視來源
# Create a key and set the role ID
key = api.ApiKey()
key.role_id = role_id

# Modify the key on Server & Workload Security保護
api_keys_api = api.APIKeysApi(api.ApiClient(configuration))
api_keys_api.modify_api_key(key_id, key, api_version)
return key.role_id
另請參閱 API 參考中的 修改 API 金鑰、刪除 API 金鑰 和 修改管理員角色 操作。
秘訣
秘訣
要使用 Server & Workload Security保護 修改 API 金鑰，請前往 Administration → User Management → API Keys，選擇 API 金鑰並點選 Properties。