ドキュメントWorkfrontWorkfront ガイド

API キーの管理

Last update: Wed Aug 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • トピック：

作成対象：

  • 管理者

API セキュリティ脆弱性を最小限に抑えるために、Adobe Workfront 管理者は、アプリケーションがユーザーに代わって Workfront へのアクセスに使用される API キーを管理できます。

現在の管理者 API キーのリセットまたは削除、API キーを期限切れに設定、すべてのユーザーの API キーの削除を行うことができます。

Workfront API を活用するアプリケーションの例を次に示します。

  • Dropbox、Google Drive、Workfront DAM などのドキュメントの統合
  • Workfront モバイルアプリケーション
IMPORTANT
API キーをリセットまたは削除する場合、Workfront API を利用し、この API キーを介して Workfront に対して認証するアプリケーションは、Workfront へのアクセス権を取り戻すために再設定する必要があります。

アクセス要件

展開すると、この記事の機能のアクセス要件が表示されます。

この記事の手順を実行するには、次のアクセス権が必要です。

table 0-row-2 1-row-2 2-row-2 layout-auto html-authored no-header
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 認証を必要とするオプションを一時的に無効にします。

  2. Adobe Workfront の右上隅にある​ メインメニュー ​アイコン メインメニュー をクリックするか、または（使用可能な場合）左上隅にある​ メインメニュー ​アイコン メインメニュー 、「設定」 設定アイコン の順にクリックします。

    1. システム ​を展開し、次に「シングルサインオン（SSO）」をクリックします。

    2. タイプ フィールドで、組織が使用する SSO のタイプを選択します。

    3. タイプを選択した状態で、下にスクロールして「有効」チェックボックスをオフにします。

    4. 保存 ​をクリックします。

  3. ブラウザーのアドレスバーに、次の API 呼び出しを入力します。

    <domain>.my.workfront.com/attask/api/v7.0/user?action=generateApiKey&username= ​username​ &password= ​password**&method=PUT

    <domain> を Workfront ドメイン名に置き換え、ユーザー名とパスワードをユーザーの Workfront 資格情報に置き換えます。

  4. （条件付き）手順 1 で SSO 認証を要求するオプションを無効にした場合は、これを有効にします。

  5. Adobe Workfront の右上隅にある​ メインメニュー ​アイコン メインメニュー をクリックするか、または（使用可能な場合）左上隅にある​ メインメニュー ​アイコン メインメニュー 、「設定」 設定アイコン の順にクリックします。

    1. システム ​を展開し、次に「シングルサインオン（SSO）」をクリックします。

    2. タイプ ​ドロップダウンメニューで、「SSO メソッド」を選択します。。

    3. 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 Business Platform にまだ登録されていない組織にのみ適用されます。組織が Adobe Business Platform にオンボーディングされている場合、Workfront API を介して Workfront にログインすることはできません。
組織が Adobe Business Platform に登録されているかどうかによって異なる手順のリストについては、プラットフォームによる管理の違い（Adobe Workfront Fusion／Adobe Business Platform）を参照してください。

サードパーティアプリケーションは、API を介して Workfront と通信できます。X.509 証明書を Workfront にアップロードすることで、Workfront サイトのセキュリティを強化するために API ログインリクエストを制限するよう Workfront を設定できます。有効にしたら、API を介したすべてのログインリクエストには、ユーザー名とパスワードに加えて、クライアント証明書が含まれている必要があります。

NOTE
組織の Workfront インスタンスが Adobe IMS によって有効化されている場合は使用できません。詳細情報が必要な場合は、ネットワークまたは IT 管理者にお問い合わせください。

X.509 証明書の取得 obtain-the-x-509-certificate

有効な X.509 証明書を信頼できる証明機関（Verisign など）から取得し、ワークステーションの一時的な場所に配置します。

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

X.509 証明書を必要とするようにWorkfrontのインスタンスを設定する前に、有効なユーザー名とパスワードのパラメーターを使用して、/login エンドポイントへの API リクエストを実行します。sessionID を含む 200 件の応答を受け取ります。

Workfront のインスタンスの顧客情報ページで X.509 証明書を要件とした後、再度ログインを試みます。今回は、「信頼できないリクエスト」というメッセージを含んだ 500 エラー応答が届きます。 システム管理者に連絡して、証明書を添付してください。」

X.509 証明書が必須であることを確認したら、証明書の値に apiCertificate の追加パラメーターを設定して、同じログインリクエストを実行します。この操作が正しく実行された場合は、有効な sessionID を含む 200 件の応答を受け取ります。

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