HTTP > Make an OAuth 2.0 request モジュール
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 プラン |
新規:標準 または 現在:仕事以上 |
Adobe Workfront Fusion ライセンス** |
現在:Workfront Fusion ライセンスは必要ありません。 または 従来のバージョン:作業の自動化と統合のためのWorkfront Fusion |
製品 |
新規:
または 現在:Adobe Workfront Fusion を購入する必要があります。 |
このテーブルの情報について詳しくは、 ドキュメントのアクセス要件を参照してください。
Adobe Workfront Fusion ライセンスについて詳しくは、Adobe Workfront Fusion ライセンスを参照してください。
OAuth リクエストの接続の作成
HTTP/Make an OAuth 2.0 request モジュールで接続を作成するための一般的な手順
-
Adobe Workfront Fusion と通信する target サービスに OAuth クライアントを作成します。このオプションは、指定されたサービスの Developer セクションにある可能性が最も高いです。
-
クライアントを作成する際に、適切な URL を
Redirect URL
またはCallback URL
フィールドに入力します:table 0-row-2 1-row-2 南北アメリカ/APAC https://app.workfrontfusion.com/oauth/cb/oauth2
EMEA https://app-eu.workfrontfusion.com/oauth/cb/oauth2
-
クライアントを作成すると、指定されたサービスは次の 2 つのキー(
Client ID
とClient Secret
)が表示されます。一部のサービスでは、これらのApp Key
とApp Secret
を呼び出します。 キーと秘密鍵を安全な場所に保存して、Workfront Fusion で接続を作成する際に指定できるようにします。
-
-
Authorize URI
およびToken URI
を特定のサービスの API ドキュメント内で探します。これらの URL アドレスを使用して Workfront Fusion は target サービスと通信します。アドレスは OAuth 認証に使用されます。note note NOTE サービスで暗黙的なフローを使用する場合、 Authorize URI
のみが必要です。 -
(条件付き)ターゲットサービスでスコープ(アクセス権)を使用する場合、サービスで個々のスコープがどのように区切られるかを確認し、それに応じて詳細設定で区切り文字を設定してください。区切り文字が正しく設定されていない場合、Workfront Fusion は接続の作成に失敗し、範囲無効エラーが表示されます。
-
上記の手順を完了したら、Workfront Fusion で OAuth 接続の作成を開始できます。「HTTP / OAuth 2 リクエストを行う」モジュールをシナリオに追加します。
-
モジュールの「接続」フィールドで、「Add」をクリックします。
-
次のフィールドに入力して、接続を作成します。
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
code
Authorization Code flow の場合は、token
の場合は Implicit flow -
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 ドキュメントから
-
「Continue」をクリックして接続を保存し、モジュールに戻ります。
-
OAuth 2.0 リクエストを行うモジュールの設定を続行します。
HTTP >Make an OAuth 2.0 request module で Google への接続を作成するための手順
次の例は、HTTP/Make an OAuth 2.0 リクエストモジュールを使用して Google に接続する方法を示しています。
-
記事 カスタム OAuth クライアントを使用したへの接続の説明に従って、プロジェクトの作成、OAuth 設定の指定、資格情報の生成が完了し Adobe Workfront Fusion いることを確認してください Google Services
-
HTTP/Make an OAuth 2.0 request モジュールを開きます。
-
接続ボックスの横にある「Add」をクリックします。
-
次の値を入力します。
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/auth
Token URI https://www.googleapis.com/oauth2/v4/token
Scope 個々のスコープを追加します。スコープについて詳しくは、Google ドキュメントにある Google API向け OAuth 2.0 スコープを参照してください。 Scope separator SPACE Client ID Google クライアント ID を入力します。
クライアント ID を作成するには、カスタム OAuth クライアントを使用した Google Services ークフローの作成に Connect Adobe Workfront Fusion する記事の OAuth 資格情報の作成を参照してください 。
Client Secret Google クライアント秘密鍵を入力します。
クライアントシークレットを作成するには、記事 Connect Adobe Workfront Fusion to Google Services using a custom OAuth client の OAuth Credentials の作成を参照してください 。
Authorize parameters access_type
-offline
キーと値のペアを追加します。メモ:トークンの更新など、認証に関する問題が発生した場合は、
prompt
-consent
キーと値のペアを試してください。 -
「Continue」をクリックして、接続設定を保存します。
-
OAuth 2.0 リクエストを行うモジュールの設定を続行します。
「OAuth 2.0 リクエストを行う」モジュールの設定
OAuth 2.0 接続を確立したら、必要に応じてモジュールの設定を続行します。 すべての認証トークンは、このリクエストと、同じ接続を使用する他のリクエストに自動的に含まれます。
HTTP/Make an OAuth 2.0 request モジュールを設定すると、以下に示 Workfront Fusion フィールドが表示されます。 モジュール内の太字のタイトルは、必須フィールドを示します。
フィールドまたは関数の上にマップボタンが表示されている場合は、このボタンを使用すると、そのフィールドの変数や関数を設定できます。詳しくは、 Adobe Workfront Fusion でモジュールから別のモジュールに情報をマッピングを参照してください。