メインコンテンツにスキップ
Adaptive Planning
最終更新: 2023-06-23
OAuth を使用した認証

OAuth を使用した認証

OAuth 認証情報を構成することにより、OAuth サービス プロバイダを使用してカスタム クラウド データ ソース (CCDS) を認証することができます。データ デザイナーが CCDS を使用する際は、ログインし、アクセス申請が認証される必要があります。
Workday 認証情報を作成した場合は、それを使って CCDS を認証することができます。

前提条件

ナビゲーション

Compass.png ナビゲーション メニューで
"インテグレーション"
>
"インテグレーション設定"
に移動します。

OAuth の設定と構成

"コンポーネント ライブラリ"
"認証情報"
ペインを使用して、OAuth の作成および管理を行います。
  1. "認証情報"
    パネルで
    "新しい認証情報の作成"
    を選択します。
  2. "OAuth 1.0a"
    または
    "OAuth 2.0"
    を選択して、認証情報名を入力し、
    "作成"
    をクリックします。OAuth 1.0a および OAuth 2.0 の認証情報は、違いが分かりやすいように、別々のアイコンを使用しています。
  3. 以下に従って
    "設定"
    に入力します。
    OAuth 1.0a
    設定に
    は以下のフィールドがあります。
    • コンシューマー キー:
      登録プロセス中に発行されるクライアント ID (クライアント識別子) です。
      コンシューマー キー
      および
      コンシューマー シークレット
      は、リクエストを申請するクライアントを識別し、認証するための認証情報ペアとなります。
    • コンシューマー シークレット
      : クライアントの秘密キー。
    • サポートされている署名方法
      : 事前定義された署名方法は、「HMAC-SHA1」であり、これを変更することはできません。
    • リクエスト トークン サービス HTTP メソッド
      : ドロップダウンで "GET" または "POST" を選択します。
    • リクエスト トークン サービス エンドポイント
      : クライアントによるトークン認証情報セットのリクエストで使用されます。
    • 認証リダイレクト URL
      : 委任リクエストの識別のために一時的な認証情報を取得するために使用される URL です。
    • アクセス トークン サービス HTTP メソッド
      : 外部アクセス トークン サービスの要件に応じて、GET または POST のいずれかを選択します。
    • アクセス トークン サービス エンドポイント
      : 保護されたリソースのアクセスに使用するトークンを取得するための URL です。
    • URL をリクエストするための OAuth パラメータの追加
      : URI スキームと命名期間の範囲内のリソースを識別するための URI です。
    OAuth 2.0 の
    設定に
    は、以下の追加のフィールドがあります。
    • コンシューマー キー:
      登録プロセス中に発行されるクライアント ID (クライアント識別子) です。
      コンシューマー キー
      および
      コンシューマー シークレット
      は、リクエストを申請するクライアントを識別し、認証するための認証情報ペアとなります。
    • コンシューマー シークレット
      : クライアントの秘密キー。
    • リダイレクト URI
      : 認証後にユーザーをリダイレクトします。インテグレーション開発者は、サード パーティのサーバー上の OAuth 2.0 アプリケーション設定中に、この URI を使用します。このフィールドは変更できません。
    • 適用範囲
      : サービス、つまり、認証アクセス申請のオブジェクトの範囲です。
    • 認証ヘッダーが必要です
      : サードパーティのサービス プロバイダが認証後にアクセス トークンを要求またはリフレッシュする際に申請に認証ヘッダーが必要な場合、このチェックボックスをオンにします。
    • アクセス トークン更新可能
      : 最初の認証プロセスで元のアクセス トークンを取得して、トークンをリフレッシュする場合、また、サードパーティのサーバーのアクセストークンが自動的に更新される場合、このチェックボックスをオンにします。
    • 認証リダイレクト URL
      : 委任申請の識別情報のための一時的な認証情報を取得するための URL です。
    • アクセス トークン サービス HTTP メソッド
      : 外部アクセス トークン サービスの要件に応じて、GET または POST のいずれかを選択します。
    • アクセス トークン サービス エンドポイント
      : 保護されたリソースのアクセスに使用するトークンを取得するための URL です。
    • トークンの有効期限デフォルト (秒)
      : 有効期限のないアクセス トークンのデフォルトの秒単位の有効期限です。
  4. "アクション"
    ペインで
    "保存"
    をクリックします。
詳細については、OAuth 1.0 および OAuth 2.0 の認証フレームワークを参照してください。

OAuth を使用した CCDS 認証

以下は、インテグレーション開発者向けのステップです。
  1. "データ ソース"
    パネルで使用する CCDS を選択します。
  2. "データ設定"
    タブで
    "認証情報が必要"
    を選択します。
  3. "認証情報"
    ドロップダウンで使用する OAuth の認証情報を選択します。
  4. "スクリプト"
    タブで、OAuth 認証情報を含むスクリプトを更新します。たとえば、次のようになります。
    response=ai.authorizedRequest(url,method,body,headers)
  5. "アクション"
    ペインで
    "保存"
    をクリックします。

認証リクエスト

以下は、データ デザイナー向けのステップです。
  1. "データ ソース"
    パネルで使用する CCDS を選択します。
  2. "アクション"
    パネルで
    "認証をリクエスト"
    を選択して、CCDS 認証リクエストを生成します。
    サードパーティの Web サイトを認証するための新しいブラウザのウィンドウが開きます。認証が完了すると、OAuth 1.0a アプリケーションがお使いのアカウントに接続して、データにアクセスすることができます。OAuth 2.0 については、サードパーティの Web サイトが許可する場合は、"OAuth 2.0
    設定"
    -
    "適用範囲"
    フィールドで提供したサービスの全範囲が示されていることがあります。
  3. リフレッシュ:
    Adaptive Planning
    CCDS データ ソース ページ
    "アクション"
    パネルのすべてのメニュー アイテムが有効化されていることに注意してください。
"データ ソース設定"
タブには、サードパーティの認証 ID を伴う
認証ステータス
および認証日が表示されます。認証の有効期限は、プロバイダにより異なります。認証の有効期限にご注意ください。
"アクション"
パネルの
"認証のリセット"
をクリックして、必要に応じて再認証を行います。
"認証のリセット"
は、サードパーティの Web サイトに別の認証情報を提供する場合に使用することができます。