OAuth認証を使用したAnaplan Connectの使い方

こんにちは!初投稿です!


タイトル通り、OAuth認証を使用したAnaplan Connectの使い方を学んだので、ここで共有できればと思います。
早速本題に入りますが、Anaplan Connectをベーシック認証で使用する場合、スクリプトファイル内にAnaplan ログインID/PWの入力が必要です。
しかし、OAuth認証を使用すればその記述が不要になります。
以下、手順になります。

前提
・OS:Windows
・ベーシック認証方法でAnaplanにログイン
・Anaplan Connectインストール済み 参考:Anaplan Connect Quick Start Guide - Windows Installation

ステップ#1 OAuthクライアントの作成


まず、OAuth 2.0 クライアントを作成します。 作成時は自身に「テナントセキュリティ管理者」権限が付与されていることを確認してください。

※権限は[Administration]>[Access Control]>[Assignments] から確認できます。
※権限がない場合、[Administration]>[Security] 配下に [OAuth Clients] が表示されません。

  1. [Administration]>[Security] >[OAuth Clients]をクリック
  2. 画面中央[Enable OAuth](初回のみ表示)をクリック → 画面中央[Create your first client](初回のみ表示)または右上[New]をクリック
  3. 表示された[Create OAuth 2.0 client]ダイアログ上でTypeに[Device grant]を設定し、[Create client]をクリック ※NameとURLsは任意の値
  4. 作成されたクライアントのクライアントIDを確認する

ステップ#2 スクリプトをコピーする

Anaplan Connectインストールディレクトリ内にサンプルスクリプトがあるので、それを任意の場所にコピーして使用すると便利です。
サンプルスクリプト名(Windows用):Authentication - Generate OAuth Token With Force Register.bat

ステップ#3 スクリプトを編集する

ステップ#2でコピーしたスクリプトを編集します。

・クライアントIDの設定
・必要なパラメーターを設定
 --forceRegister:デバイス認証確認用
 --rotatable :ステップ#1-4でリフレッシュトークンに[Rotatable]を選択した場合に必要
・Anaplan Connectインストール場所に応じてパスを設定

(編集前)

(編集後)

ステップ#4 スクリプトを実行して、デバイス認証する

  1. コマンドプロンプトを起動し、スクリプトを実行する
  2. 提供されたURLをInPrivateウインドウで開いて、ベーシック認証でユーザを認証する

  ↓この1画面は初回のみ表示されます

 このタイミングでAnaplan Connectスクリプトが実行されているデバイスを認証しています。

ステップ#5 Force Register パラメーターを削除し、スクリプトを自動的に実行できるようにする

ユーザー認証によってデバイスが正常に承認されたら、スクリプトからパラメーター(—forceRegister)を削除した状態で再実行します。

 これで準備完了です!

 以降は、スクリプト内にIDPWを設定する必要なく、実行することができます。

補足

  • 上記手順では認証に必要な最低限の情報で実行していますが、実際はインポートやエクスポートアクションなど処理が設定されたスクリプトファイルで認証を行います。その場合のスクリプト例を載せておきます。
    例:モジュールに対してデータインポートを行うスクリプト

  • デバイス認証の有効期限について(リフレッシュトークンにRotableを選択した場合)
    最大1年(31,556,952秒)まで設定できます。
    有効期限が切れた場合にスクリプト実行すると以下のようにエラーになります。
    その場合は、再度デバイス認証する必要があります。
    (Force Register パラメーターを設定した状態でのスクリプト実行が必要)