ドキュメントWorkfrontWorkfront ガイド

HTTP／OAuth 2.0 リクエスト作成モジュール

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

作成対象：

  • ユーザー
NOTE
Adobe Workfront Fusion には Adobe Workfront ライセンスに加えて Adobe Workfront Fusion ライセンスが必要です。

OAuth 2.0 認証を必要とするサーバーに対する Adobe Workfront Fusion HTTP(S) リクエストを実行するには、まず OAuth 接続を作成する必要があります。Adobe Workfront Fusion は、この接続で行われたすべての呼び出しに適切な認証ヘッダーが付いていることを確認し、必要に応じて関連トークンを自動的に更新します。

Workfront Fusion は、次の OAuth 2.0 認証フローをサポートしています。

  • 認証コードフロー
  • 暗黙フロー

リソース所有者パスワード資格情報フローやクライアント資格情報フローなど、その他のフローは、このモジュールを通じて自動的にはサポートされません。

OAuth 2.0 認証について詳しくは、OAuth 2.0 承認フレームワークを参照してください。

NOTE
現在専用コネクタがないAdobe製品に接続する場合は、Adobe Authenticator モジュールを使用することをお勧めします。
詳しくは、Adobe Authenticator モジュールを参照してください。

アクセス要件

この記事で説明している機能を使用するには、次のアクセス権が必要です。

Adobe Workfront プラン*
Pro 以降
Adobe Workfront ライセンス*
Plan、Work
Adobe Workfront Fusion ライセンス**

現在のライセンス要件：Workfront Fusion ライセンス要件なし。

または

従来のライセンス要件：Workfront Fusion for Work Automation and Integration

製品

現在の製品要件：Select または Prime Adobe Workfront プランがある場合、この記事で説明する機能を使用するには、組織で Adobe Workfront Fusion の購入 Adobe Workfront 必要です。 Workfront Fusion は、Workfront Ultimate プランに含まれています。

または

従来の製品要件：この記事で説明している機能を使用するには、Adobe Workfront Fusion と Adobe Workfrontを組織で購入する必要があります。

ご利用のプラン、ライセンスの種類、アクセス権を確認するには、Workfront 管理者にお問い合わせください。

Adobe Workfront Fusion ライセンスについて詳しくは、Adobe Workfront Fusion ライセンスを参照してください。

OAuth リクエストへの接続を作成

HTTP で接続を作成するための一般的な手順／OAuth 2.0 リクエスト作成モジュール

  1. Adobe Workfront Fusion と通信する target サービスに OAuth クライアントを作成します。このオプションは、所定のサービスの開発者セクションに含まれていることが多いです。

    1. クライアントを作成する際に、適切な 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. クライアントを作成すると、指定されたサービスは次の 2 つのキー（Client ID と Client Secret）が表示されます。これらの App Key および App Secret を呼び出すサービスもあります。キーと秘密鍵を安全な場所に保存して、Workfront Fusion で接続を作成する際に指定できるようにします。

  2. Authorize URI および Token URI を特定のサービスの API ドキュメント内で探します。これらの URL アドレスを使用して Workfront Fusion は target サービスと通信します。アドレスは OAuth 認証に使用されます。

    note note
    NOTE
    サービスで暗黙的なフローを使用する場合、Authorize URI のみが必要です。
    note info
    INFO
    例： Yahoo アドレス：
    • URI を許可：
    https://api.login.yahoo.com/oauth2/request_auth
    • トークン URI：
    https://api.login.yahoo.com/oauth2/get_token

  3. （条件付き）ターゲットサービスでスコープ（アクセス権）を使用する場合、サービスで個々のスコープがどのように区切られるかを確認し、それに応じて詳細設定で区切り文字を設定してください。区切り文字が正しく設定されていない場合、Workfront Fusion は接続の作成に失敗し、範囲無効エラーが表示されます。

  4. 上記の手順を完了したら、Workfront Fusion で OAuth 接続の作成を開始できます。OAuth 2.0 HTTP(S) リクエストおよび応答処理モジュールをシナリオに追加します。

  5. モジュールの「接続」フィールドで、「追加」をクリックします。

  6. 次のフィールドに入力して、接続を作成します。

    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 layout-auto html-authored no-header
    Connection name 接続の名前を入力します。
    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。

  7. 「続行」をクリックして接続設定を保存します。

  8. OAuth 2.0 リクエストモジュールのセットアップに継続します。

HTTP／OAuth 2.0 リクエスト作成モジュールで Google への接続を作成する手順

次の例は、HTTP／OAuth 2.0 実行リクエストモジュールを使用して Google に接続する方法を示しています。

  1. カスタム OAuth クライアントを使用して Adobe Workfront Fusion を Google Services に接続するに説明されているように、プロジェクトを作成、OAuth 設定を行い、資格情報が生成されていることを確認します。

  2. HTTP／OAuth 2.0 実行リクエストモジュールを開きます。

  3. 接続ボックスの横にある「追加」をクリックします。

  4. 次の値を入力します。

    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 layout-auto html-authored no-header
    Connection name 接続の名前を入力します。
    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 クライアントを使用して Connect Adobe Workfront Fusion を Google Services に接続」の OAuth 資格情報を作成を参照してください。
    Client Secret

    Google クライアント秘密鍵を入力します。

    クライアント秘密鍵を作成するには、「OAuth クライアントを使用して Connect Adobe Workfront Fusion を Google サービスに接続」の OAuth 資格情報を作成を参照してください。
    Authorize parameters

    access_type - offline キーと値のペアを追加します。

    メモ：トークンの更新など、認証に関する問題が発生した場合は、prompt - consent キーと値のペアを試してください。

  5. 「続行」をクリックして接続設定を保存します。

  6. OAuth 2.0 リクエストモジュールのセットアップに継続します。

Microsoft Graph API に HTTP／OAuth 2.0 リクエストを作成 モジュール経由で接続する手順

Microsoft Graph API に関する手順については、 Adobe Workfront Fusion HTTP 経由で MS Graph REST API を呼び出す／OAuth 2.0 リクエストを作成モジュールを参照してください。

OAuth 2.0 リクエストモジュールの設定

OAuth リクエストのための接続を作成の説明に従って Oauth 2.0 接続を確立したら、必要に応じてモジュールの設定を続けます。すべての認証トークンは、このリクエストと、同じ接続を使用する他のリクエストに自動的に含まれます。

HTTP／OAuth 2.0 リクエストを作成モジュールを構成すると、Workfront Fusion に以下のフィールドが表示されます。モジュール内の太字のタイトルは、必須フィールドを示します。

フィールドまたは関数の上にマップボタンが表示されている場合は、このボタンを使用すると、そのフィールドの変数や関数を設定できます。詳しくは、 Adobe Workfront Fusion のモジュール間での情報のマッピングを参照してください。

Connection
接続の設定の詳細については、この記事の OAuth リクエスト用の接続を作成を参照してください。
Evaluate all states as errors (except for 2xx and 3xx)

エラー処理を設定するには、このオプションを使用します。

詳しくは、Adobe Workfront Fusion でのエラー処理を参照してください。

URL
API エンドポイント、ウェブサイトなど、リクエストの送信先 URL を入力します。
Method
API 呼び出しの設定に必要な HTTP リクエストメソッドを選択します。詳しくは、Adobe Workfront Fusionでの HTTP リクエストメソッドを参照してください。
Headers
リクエストのヘッダーを標準 JSON オブジェクトの形式で追加します。例： {"Content-type":"application/json"}
Query String
目的のクエリのキーと値のペアを入力します。
Body type

HTTP 本文は、使用するヘッダーがある場合、そのヘッダーの直後に HTTP トランザクションメッセージで送信されるデータバイトです。

  • Raw

    Raw 本文タイプは、開発者向けドキュメントで送信するデータが指定されていない場合でも、通常、ほとんどの HTTP 本文リクエストに適しています。

    データを解析する形式を Content type フィールドに指定します。

    選択したコンテンツタイプに関係なく、データは開発者ドキュメントで規定または必須されている形式で入力されます。

  • Application/x-www-form-urlencoded

    この本文タイプは、application/x-www-form-urlencoded を使用したデータの投稿です。

    application/x-www-form-urlencoded の場合、サーバーに送信される HTTP メッセージの本文は基本的に 1 つのクエリ文字列になります。キーと値はキーと値のペアでエンコードされます。ペア同士は & で区切られ、各ペアのキーと値の間には = が入ります。

    バイナリデータの場合は、代わりに use multipart/form-data。

    例：

    結果の HTTP リクエスト形式の例は、次のようになります。

    field1=value1&field2=value2

  • Multipart/form-data

    Multipart/form-data は、ファイルとデータの送信に使用される HTTP マルチパートリクエストです。通常、ファイルをサーバーにアップロードする際に使用されます。

    リクエストで送信するフィールドを追加します。各フィールドには、キーと値のペアが含まれている必要があります。

    • Text

      リクエスト本文内で送信するキーと値を入力します。

    • File

      キーを入力し、リクエスト本文で送信するソースファイルを指定します。

      前のモジュールからアップロードするファイルをマッピングするか（HTTP／Get a File または Google Drive／Download a File）、またはファイル名とファイルデータを手動で入力します。

Parse response

このオプションを有効にすると、応答を自動的に解析し、JSON および XML 応答を変換するので、JSON／Parse JSON または XML／Parse XML モジュールを使用する必要がなくなります。

解析された JSON または XML コンテンツを使用する前に、モジュールを手動で 1 回実行して、モジュールが応答コンテンツを認識し、後続のモジュールにマッピングできるようにします。

Timeout
リクエストのタイムアウトを秒単位で入力します（1～300）。デフォルトは 40 秒です。
Share cookies with other HTTP modules
このオプションを有効にすると、シナリオ内のすべての HTTP モジュールとサーバーから Cookie を共有できます。
Self-signed certificate
自己署名証明書を使用して TLS を使用する場合は、証明書をアップロードします。
Reject connections that are using unverified (self-signed) certificates
このオプションを有効にすると、未検証の TLS 証明書を使用している接続を拒否できます。
Follow redirect
このオプションを有効にすると、3xx 応答で URL リダイレクトに従います。
Follow all redirects
このオプションを有効にすると、すべての応答コードで URL リダイレクトに従います。
Disable serialization of multiple same query string keys as arrays
デフォルトでは、Workfront Fusion は、配列と同じ URL クエリ文字列パラメーターキーに対する複数の値を処理します。例えば、www.test.com?foo=bar&foo=baz が www.test.com?foo[0]=bar&foo[1]=baz に変換されます。このオプションをアクティブ化すると、この機能は無効になります。
Request compressed content

このオプションを有効にすると、web サイトの圧縮バージョンを要求できます。

これにより、圧縮コンテンツを要求する Accept-Encoding ヘッダーが追加されます。

Use Mutual TLS

このオプションを有効にすると、HTTP リクエストで相互 TLS を使用できます。

相互 TLS について詳しくは、Adobe Workfront Fusion の HTTP モジュールで相互 TLS を使用を参照してください。

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