文件WorkfrontWorkfront 指南

管理API金鑰

Last update: Fri Apr 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主題：

建立對象：

  • undefined

為了將API安全性弱點降至最低，Adobe Workfront管理員可以管理API金鑰，讓應用程式能夠代表使用者存取Workfront。

您可以重設或移除目前的管理員API金鑰、設定API金鑰過期時間，以及移除所有使用者的API金鑰。

以下是運用Workfront API的應用程式範例：

  • 檔案整合，例如Dropbox、Google Drive和Workfront DAM
  • Workfront行動應用計畫
IMPORTANT
重設或移除API金鑰時，任何運用Workfront API並透過此API金鑰向Workfront驗證的應用程式都必須重新設定，才能重新取得Workfront的存取許可權。

存取需求

您必須具有下列存取權才能執行本文中的步驟：

Adobe Workfront計畫
任何
Adobe Workfront授權
計劃
存取層級設定

您必須是Workfront管理員。

注意：如果您還是沒有存取權，請詢問Workfront管理員是否對您的存取層級設定了其他限制。 如需有關Workfront管理員如何修改您的存取層級的資訊，請參閱 建立或修改自訂存取層級.

Workfront API金鑰

Workfront中的每個使用者都有唯一的API金鑰。 使用者存取運用Workfront API (例如Workfront行動應用程式或檔案整合)的整合時，系統會為每個使用者產生此金鑰。

NOTE
您在生產環境中產生的API金鑰會在每週重新整理期間複製到您的預覽環境。 在每週重新整理期間，您在預覽環境中產生的任何API金鑰都會被生產API金鑰覆寫。

Workfront管理員也有唯一的API金鑰。 當應用程式使用管理員API金鑰存取Workfront時，該應用程式將可存取Workfront的管理員存取權。

管理管理員API金鑰

您可以為管理員使用者帳戶產生、重設或移除API金鑰。

NOTE
您也可以透過API產生API金鑰。 如需詳細資訊，請參閱 事件訂閱API 中的區段 事件訂閱API.

  1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

  2. 按一下 系統> 客戶資訊。

  3. （視條件而定）執行下列其中一項動作：

    若要產生API金鑰：在 API金鑰設定 區段，按一下 產生API金鑰.

    或
    重設API金鑰：在 API金鑰設定 區段，按一下 重設，然後 重設。

    或

    移除API金鑰：在 API金鑰設定 區段，按一下 移除，然後 移除.

為非管理員使用者產生API金鑰

您可以為角色不是Workfront管理員的使用者產生和管理API金鑰。

NOTE
如果您組織的Workfront執行個體已啟用Adobe IMS，便無法使用此功能。 如需詳細資訊，請洽詢您的網路或IT管理員。

  1. （視條件而定）如果您的組織使用單一登入(SSO)存取管理，請暫時停用需要SSO驗證的選項。

    1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

    2. 展開 系統，然後按一下 單一登入(SSO).

    3. 在 型別 欄位中，選取貴組織使用的SSO型別。

    4. 選取型別後，向下捲動並清除 啟用 核取方塊。

    5. 按一下「儲存」。

  2. 在瀏覽器的位址列中，輸入下列API呼叫：

    <domain>.my.workfront.com/attask/api/v7.0/user?action=generateApiKey&username= ​使用者名稱​ ​密碼(&P)= ​密碼**&method=PUT

    取代 <domain> 連同您的Workfront網域名稱，以及使用者名稱和密碼以及使用者的Workfront憑證。

  3. （視條件而定）如果您在步驟1中停用SSO驗證，請啟用該選項。

    1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

    2. 展開 系統，然後按一下 單一登入(SSO).

    3. 選擇您的SSO方法，在 型別 下拉式功能表。

    4. 核取需要SSO驗證的核取方塊。

設定API金鑰何時到期

您可以設定API金鑰，讓系統中所有使用者到期。 當使用者的API金鑰過期時，使用者必須向使用Workfront API存取Workfront的任何應用程式重新驗證。 您可以變更API金鑰的過期頻率。 您也可以設定API金鑰是否在使用者密碼過期時過期。

  1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

  2. 按一下 系統 > 客戶資訊.

  3. 在 API金鑰設定 區域，在 建立後， API金鑰的過期時間 下拉式清單，選取您希望API金鑰過期的時間範圍。

    當您變更此選項時，新的時間範圍將從您進行變更的時間開始。 例如，如果您將此選項從 1個月 至 6個月，API金鑰將在您進行變更後6個月到期。

    根據預設，API金鑰每個月都會過期。

  4. 若要設定API金鑰在使用者的密碼過期時過期，請選取 當使用者的密碼過期時，移除API金鑰.

    依預設，不會選取此選項。

    如需有關如何設定使用者密碼到期的資訊，請參閱 設定系統安全性偏好設定.

  5. 按一下「儲存」。

移除所有使用者的API金鑰

如果您對Workfront系統特定的安全性違反有所顧慮，您可以同時為所有使用者移除API金鑰。

IMPORTANT
移除所有使用者的API金鑰會使系統中所有使用者的所有API金鑰失效。 在您於Workfront中產生新的API金鑰並更新所有整合之前，此動作會導致Workfront中的所有整合失敗。

  1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

  2. 展開 系統，然後按一下 客戶資訊。

  3. 在 API金鑰設定 區域，按一下 移除所有API金鑰，然後按一下 移除 全部.

使用X.509憑證限制API登入

IMPORTANT
本節所述的程式僅適用於尚未加入「Adobe業務平台」的組織。 如果您的組織已加入Adobe Business Platform，就無法透過Workfront API登入Workfront。
如需根據貴組織是否已加入Adobe Business Platform而有所差異的程式清單，請參閱 平台型管理差異(Adobe Workfront/Adobe Business Platform).

協力廠商應用程式可透過API與Workfront通訊。 為了提高Workfront網站的安全性，您可以將Workfront設定為透過將X.509憑證上傳到Workfront來限制API登入請求。 啟用後，所有透過API的登入請求都必須包含使用者端憑證以及使用者名稱和密碼。

NOTE
如果您組織的Workfront執行個體已啟用Adobe IMS，便無法使用此功能。 如需詳細資訊，請洽詢您的網路或IT管理員。

取得X.509憑證 obtain-the-x-509-certificate

從受信任的憑證授權單位（例如Verisign）取得有效的X.509憑證，並將其放置在工作站上的暫存位置。

將憑證上傳至Workfront upload-the-certificate-to-workfront

從憑證授權單位取得X.509憑證後，您需要將它上傳到Workfront。

  1. 按一下 主要功能表 圖示 (位於Adobe Workfront的右上角)，然後按一下 設定 .

  2. 展開 系統，然後按一下 客戶資訊.

  3. 在 API金鑰設定 區域，選取 啟用X.509憑證.

  4. 在您的工作站上，瀏覽並選取您先前下載的X.509憑證。

  5. （選用）按一下 檢視詳細資料 在憑證名稱旁邊，即可檢視下列有關憑證的詳細資訊：

    • 主題一般名稱
    • 主題組織
    • 主題組織單位
    • 發行者一般名稱
    • 發行者組織
    • 發行者組織單位
    • 序號
    • 發行日期
    • 到期日期

  6. 按一下「儲存」。

驗證API登入呼叫是否受到限制 verify-api-login-calls-are-restricted

在設定您的Workfront執行個體以要求X.509憑證之前，請對 /login 端點使用有效的使用者名稱和密碼引數。 您將會收到包含sessionID的200回應。

在透過您Workfront例項中的客戶資訊頁面要求X.509憑證後，請再次嘗試登入。 這次您會收到500錯誤回應，並出現下列訊息：「Untrusted request. 請連絡您的系統管理員並附加憑證。」

確認需要X.509憑證後，使用設為您的憑證值的額外apiCertificate引數，執行相同的登入要求。 如果正確執行此作業，您將會收到包含有效sessionID的200回應。

recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43