HTTP/OAuth 2.0 リクエストを実行モジュール
OAuth 2.0認証を必要とするサーバーにAdobe Workfront Fusion HTTP (S)リクエストを行うには、まずOAuth接続を作成する必要があります。 Adobe Workfront Fusionを使用すると、この接続で行われたすべての呼び出しに適切な認証ヘッダーが設定され、必要に応じて関連するトークンが自動的に更新されます。
Workfront Fusionは、次のOAuth 2.0認証フローをサポートしています。
- 認証コードフロー
- 暗黙フロー
リソース所有者パスワード資格情報フローやクライアント資格情報フローなど、その他のフローは、このモジュールを通じて自動的にはサポートされません。
OAuth 2.0 認証について詳しくは、OAuth 2.0 承認フレームワークを参照してください。
アクセス要件
| table 0-row-2 1-row-2 2-row-2 3-row-2 layout-auto html-authored no-header | |
|---|---|
| Adobe Workfront パッケージ |
任意の Adobe Workfront Workflow パッケージと任意の Adobe Workfront Automation および Integration パッケージ Workfront Ultimate Workfront Fusion を追加購入した Workfront Prime および Select パッケージ。 |
| Adobe Workfront ライセンス |
標準 Work またはそれ以上 |
| Adobe Workfront Fusion ライセンス |
オペレーションベース:Workfront Fusion ライセンス要件なし コネクターベース(レガシー):Workfront Fusion for Work Automation および Integration |
| 製品 | 組織が Workfront Automation および Integration を含まない Select またはPrime Workfront パッケージを持っている場合は、Adobe Workfront Fusion を購入する必要があります。 |
この表の情報について詳しくは、ドキュメントのアクセス要件を参照してください。
Adobe Workfront Fusion ライセンスについて詳しくは、Adobe Workfront Fusion ライセンスを参照してください。
OAuth リクエストの接続を作成
HTTP で接続を作成するための一般的な手順/OAuth 2.0 リクエスト作成モジュール
-
Adobe Workfront Fusionと通信するtarget サービスでOAuth クライアントを作成します。 このオプションは、所定のサービスの開発者セクションに含まれていることが多いです。
-
クライアントを作成する際に、適切な URL を
Redirect URLまたはCallback URLフィールドに入力します:table 0-row-2 1-row-2 南北アメリカ/APAC https://app.workfrontfusion.com/oauth/cb/oauth2EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2 -
クライアントを作成すると、指定されたサービスは次の 2 つのキー(
Client IDとClient Secret)が表示されます。 一部のサービスでは、これらをApp KeyおよびApp Secretと呼んでいます。 キーと秘密鍵を安全な場所に保存して、Workfront Fusion で接続を作成する際に指定できるようにします。
-
-
Authorize URIおよびToken URIを特定のサービスの API ドキュメント内で探します。 これらは、Workfront Fusionがtarget サービスと通信するURL アドレスです。 アドレスは OAuth 認証に使用されます。note NOTE サービスで暗黙的なフローを使用する場合、 Authorize URIのみが必要です。 -
(条件付き)ターゲットサービスでスコープ(アクセス権)を使用する場合、サービスで個々のスコープがどのように区切られるかを確認し、それに応じて詳細設定で区切り記号を設定してください。 区切り記号が正しく設定されていない場合、Workfront Fusionは接続の作成に失敗し、無効なスコープエラーが表示されます。
-
上記の手順を完了したら、Workfront FusionでOAuth接続の作成を開始できます。 HTTP/OAuth 2 リクエストモジュールをシナリオに追加します。
-
モジュールの「接続」フィールドで、「追加」をクリックします。
-
次のフィールドに入力して、接続を作成します。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 11-row-2 12-row-2 13-row-2 14-row-2 15-row-2 16-row-2 17-row-2 18-row-2 layout-auto html-authored no-header Connection name 接続の名前を入力します。 Environment 実稼動環境と非実稼動環境のどちらを使用するかを選択します。 Type サービスアカウントと個人アカウントのどちらを使用しているかを選択します。 Flow type トークンを取得するフローを選択します。
- Authorization Code:サービスの API ドキュメントにある
Authorize URIとToken URIを入力します。 - Implicit:サービスの API ドキュメントにある
Authorize URIを入力してください。
Scope 個々のスコープを追加します。 この情報は、特定のサービスの開発者向けドキュメント(API)に記載されています。 Scope separator 上記で入力したスコープを区切る範囲を選択します。 この情報は、特定のサービスの開発者向けドキュメント(API)に記載されています。
警告:区切り記号が正しく設定されていない場合、Workfront Fusionは接続の作成に失敗し、無効なスコープエラーが表示されます。
Client ID クライアント ID を入力します。 クライアント ID は、接続するサービスで OAuth クライアントを作成したときに取得されました。 Client Secret クライアントの秘密鍵を入力します。 接続するサービスで OAuth クライアントを作成したときに、クライアントシークレットを取得しました。 Authorize parameters 認証呼び出しに含めるパラメーターを追加します。 次の標準パラメーターは常に自動的に含まれるため、追加する必要はありません。
標準パラメーター:
-
response_type
Authorization Code flow 用の
codeおよび Implicit flow 用のtokenの場合 -
redirect_uri
table 0-row-2 1-row-2 layout-auto html-authored no-header 南北アメリカ/APAC https://app.workfrontfusion.com/oauth/cb/oauth2 EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2 -
client_id
アカウントの作成時に受け取ったクライアント ID
Access token parameters トークン呼び出しに含めるパラメーターを追加します。 次の標準パラメーターは常に自動的に含まれるため、追加する必要はありません。
標準パラメーター:
-
grant_type:
authorization_code -
redirect_uri:
table 0-row-2 1-row-2 layout-auto html-authored no-header 南北アメリカ/APAC https://app.workfrontfusion.com/oauth/cb/oauth2 EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2 -
client_id:アカウントの作成時に受け取ったクライアント ID は、リクエスト本文に自動的に含まれます
-
client_secret:アカウントの作成時に受け取ったクライアントシークレットが、リクエスト本文に自動的に含まれます
-
コード:認証リクエストによって返されるコード
メモ:
OAuth 2.0 標準は、この手順で少なくとも 2 つのクライアント認証方法(
client_secret_basicおよびclient_secret_post)をサポートします。 Workfront Fusionは、指定されたクライアント IDとシークレットをclient_secret_postメソッドを通じて自動的に送信します。 したがって、これらのパラメーターは、トークンのリクエスト本文に自動的に含まれます。OAuth 2.0 認証について詳しくは、OAuth 2.0 承認フレームワークを参照してください。
Refresh token parameters トークン呼び出しに含めるパラメーターを追加します。 次の標準パラメーターは常に自動的に含まれるため、追加する必要はありません。
標準パラメーター:
-
grant_type:
refresh_token -
refresh_token:接続しているサービスで取得された最新の更新トークン。
-
client_id:アカウントの作成時に受け取ったクライアント ID は、リクエスト本文に自動的に含まれます
-
client_secret:アカウントの作成時に受け取ったクライアント秘密鍵は、リクエスト本文に自動的に含まれます
メモ:
OAuth 2.0 標準は、この手順で少なくとも 2 つのクライアント認証方法(
client_secret_basicおよびclient_secret_post)をサポートします。 Workfront Fusionは、指定されたクライアント IDとシークレットをclient_secret_postメソッドを通じて自動的に送信します。 したがって、これらのパラメーターは、トークンのリクエスト本文に自動的に含まれます。OAuth 2.0 認証について詳しくは、OAuth 2.0 承認フレームワークを参照してください。
Custom Headers Token および Refresh Token の手順のヘッダーに含める追加のキーと値を指定します。
メモ:
OAuth 2.0 標準は、この手順で少なくとも 2 つのクライアント認証方法(
client_secret_basicおよびclient_secret_post)をサポートします。 Workfront Fusionは、client_secret_basicメソッドを自動的にサポートしません。 接続しているサービスで、クライアント ID とクライアント秘密鍵が 1 つの文字列に結合され、Authorization ヘッダーに base64 がエンコードされると想定される場合は、そのヘッダーとキーの値をここに追加する必要があります。OAuth 2.0 認証について詳しくは、OAuth 2.0 認証フレームワークを参照してください。
Token placement 指定した URL に接続する際に、header、query string、またはその両方でトークンを送信するかどうかを選択します。
トークンは、最も一般的にリクエストヘッダーで送信されます。
Header token name ヘッダーに認証トークンの名前を入力します。 デフォルト: Bearer。Query string parameter name クエリ文字列に認証トークンの名前を入力します。 デフォルト: access_token。 - Authorization Code:サービスの API ドキュメントにある
-
「続行」をクリックして接続を保存し、モジュールに戻ります。
-
引き続きOAuth 2.0 リクエストモジュールの作成を設定します。
HTTP > でGoogleへの接続を作成するための手順OAuth 2.0 リクエストモジュールを作成する
次の例は、HTTP/OAuth 2.0 実行リクエストモジュールを使用して Google に接続する方法を示しています。
-
カスタム OAuth クライアント 🔗を使用してAdobe Workfront Fusionを Google Services に接続するの記事に記載されているように、プロジェクトを作成し、OAuth設定を設定し、資格情報を生成していることを確認します。
-
HTTP > OAuth 2.0 リクエスト モジュールを開きます。
-
任意のモジュールで、接続ボックスの横にある 追加 をクリックします。
-
次の値を入力します。
table 0-row-2 1-row-2 2-row-2 3-row-2 4-row-2 5-row-2 6-row-2 7-row-2 8-row-2 9-row-2 10-row-2 layout-auto html-authored no-header Connection name 接続に名前を入力します。 Environment 実稼動環境と非実稼動環境のどちらを使用するかを選択します。 Type サービスアカウントと個人アカウントのどちらを使用しているかを選択します。 Flow type Authorization Code Authorize URI https://accounts.google.com/o/oauth2/v2/authToken URI https://www.googleapis.com/oauth2/v4/tokenScope 個々のスコープを追加します。 スコープについて詳しくは、Google ドキュメントにある Google API向け OAuth 2.0 スコープを参照してください。 Scope separator SPACE Client ID Google クライアント ID を入力します。
クライアント IDを作成するには、カスタム OAuth クライアント を使用して記事Connect Adobe Workfront FusionからGoogle Servicesの「OAuth資格情報を作成」を参照してください。
Client Secret Google クライアント秘密鍵を入力します。
クライアント秘密鍵を作成するには、カスタム OAuth クライアント を使用して記事Connect Adobe Workfront FusionからGoogle サービスのOAuth資格情報を作成を参照してください。
Authorize parameters access_type-offlineキーと値のペアを追加します。
メモ:トークンの更新など、認証に関する問題が発生した場合は、
prompt-consentキーと値のペアを試してください。 -
「続行」をクリックして接続設定を保存します。
-
引き続きOAuth 2.0 リクエストモジュールの作成を設定します。
OAuth 2.0 リクエストモジュールの設定
OAuth 2.0接続を確立したら、必要に応じてモジュールの設定を続行します。 すべての認証トークンは、このリクエストと、同じ接続を使用する他のリクエストに自動的に含まれます。
HTTP > OAuth 2.0 リクエストを作成 モジュールを設定すると、Workfront Fusionに次のフィールドが表示されます。 モジュール内の太字のタイトルは、必須フィールドを示します。
フィールドまたは関数の上にマップボタンが表示されている場合は、このボタンを使用すると、そのフィールドの変数や関数を設定できます。 詳しくは、Adobe Workfront Fusion でのモジュール間の情報のマッピングを参照してください。