RazorSQL からPingOne のデータに連携。

こんにちは！ドライバー周りのヘルプドキュメントを担当している古川です。

CData JDBC Driver for PingOne を使って、各種ツールからPingOne のデータにアクセスすることが可能になります。本記事では、PingOne のデータにRazorSQL のウィザードから連携利用する方法を紹介します。

PingOne JDBC Data Source の設定

1. RazorSQL アプリケーションを開いて、Connections メニューから、Add Connection Profile -> Other -> JDBC にナビゲートします。
2. Connection Wizard で、以下を設定します：
   • Driver Location:JDBC Driver のインストールディレクトリのlib サブフォルダに設定します。
   • Driver Class: ドライバークラスを cdata.jdbc.pingone.PingOneDriver に設定します。
   • Username:ユーザー名。（ユーザー名をブランクにして、JDBC URL 内で設定することも可能です。）
   • Password:パスワード。（ユーザー名をブランクにして、JDBC URL 内で設定することも可能です。）

   • JDBC URL:接続パラメータを入力します：jdbc:pingone: から始まるJDBC URL を入力します。接続プロパティをカンマ区切りで書きます。

     PingOne に接続するには以下のプロパティを設定します。

     • Region：自身のPingOne 組織のデータがホスティングされている地域。
     • AuthScheme：PingOne に接続する際に使用する認証の種類。
     • WorkerAppEnvironmentId （デフォルトのPingOne ドメインを使用する場合に必要）、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。

     WorkerAppEnvironmentId の設定

     WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。 このパラメータは、環境がデフォルトのPingOne ドメイン（auth.pingone）を利用している場合のみ使用されます。 これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。

     はじめに、このプロパティの値を見つけます。

     1. 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
     2. OAuth / Worker のカスタムアプリケーションを作成した環境（通常はAdministrators）を見つけ、Manage Environment をクリックします。 環境のホームページが表示されます。
     3. 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
     4. リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
     5. Environment ID フィールドの値をコピーします。 以下の例に似たものになるはずです：
        WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

     次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。

     AuthorizationServerURL の設定

     AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。 このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。

     OAuth でのPingOne への認証

     PingOne はOAuth とOAuthClient 認証の両方をサポートしています。 上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。

     • ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
     • ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
     • 以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。

     OAuth（認可コードグラント）

     AuthScheme をOAuth に設定します。

     デスクトップアプリケーション

     OAuth アクセストークンの取得およびリフレッシュ

     以下を設定して、接続してください。

     • InitiateOAuth：GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
     • OAuthClientId：カスタムOAuth アプリケーションを作成した際に取得したClient ID。
     • OAuthClientSecret：カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
     • CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例：https://localhost:3333

     接続すると、本製品 はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 ドライバーはこれでOAuth プロセスを完了します。

     1. ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
     2. OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

     ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。

     Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。

     一般的なURL ：:

     jdbc:pingone:AuthScheme=OAuth;WorkerAppEnvironmentId=eebc33a8-xxxx-4f3a-yyyy-d3e5262fd49e;Region=NA;OAuthClientId=client_id;OAuthClientSecret=client_secret;

3. PingOne に接続するには以下のプロパティを設定します。

   • Region：自身のPingOne 組織のデータがホスティングされている地域。
   • AuthScheme：PingOne に接続する際に使用する認証の種類。
   • WorkerAppEnvironmentId （デフォルトのPingOne ドメインを使用する場合に必要）、またはAuthorizationServerURL のいずれかで、下で説明するように設定します。

   WorkerAppEnvironmentId の設定

   WorkerAppEnvironmentId は、Worker アプリケーションが存在するPingOne 環境のID です。 このパラメータは、環境がデフォルトのPingOne ドメイン（auth.pingone）を利用している場合のみ使用されます。 これは、ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、PingOne への認証に使用するカスタムOAuth アプリケーションを作成した後に設定します。

   はじめに、このプロパティの値を見つけます。

   1. 自身のPingOne 組織のホームページからナビゲーションサイドバーに移動し、Environments をクリックします。
   2. OAuth / Worker のカスタムアプリケーションを作成した環境（通常はAdministrators）を見つけ、Manage Environment をクリックします。 環境のホームページが表示されます。
   3. 環境のホームページのナビゲーションサイドバーで、Applications をクリックします。
   4. リストから、OAuth またはWorker アプリケーションの詳細を見つけます。
   5. Environment ID フィールドの値をコピーします。 以下の例に似たものになるはずです：
      WorkerAppEnvironmentId='11e96fc7-aa4d-4a60-8196-9acf91424eca'

   次に、WorkerAppEnvironmentId をEnvironment ID フィールドの値に設定します。

   AuthorizationServerURL の設定

   AuthorizationServerURL は、お使いのアプリケーションが配置されている環境のPingOne 認可サーバーのベースURL です。 このプロパティは、PingOne プラットフォームAPI ドキュメントで説明されているように、環境にカスタムドメインを設定した場合にのみ使用されます。 Custom Domains を参照してください。

   OAuth でのPingOne への認証

   PingOne はOAuth とOAuthClient 認証の両方をサポートしています。 上述の設定手順に加え、OAuth またはOAuthCliet 認証をサポートするために、さらに2つの手順を完了する必要があります。

   • ヘルプドキュメントのカスタムOAuth アプリケーションの作成で説明するように、カスタムOAuth アプリケーションを作成して設定します。
   • ドライバーがデータモデル内のエンティティにアクセスできるようにするには、ヘルプドキュメントのAdministrator Roles での説明のとおり、使用するアドミンユーザー / ワーカーアプリケーションに対して正しいロールを設定していることを確認してください。
   • 以下のサブセクションで説明されているように、選択した認証スキームと認証フローに適切なプロパティを設定します。

   OAuth（認可コードグラント）

   AuthScheme をOAuth に設定します。

   デスクトップアプリケーション

   OAuth アクセストークンの取得およびリフレッシュ

   以下を設定して、接続してください。

   • InitiateOAuth：GETANDREFRESH。繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要をなくすには、InitiateOAuth を使用します。
   • OAuthClientId：カスタムOAuth アプリケーションを作成した際に取得したClient ID。
   • OAuthClientSecret：カスタムOAuth アプリケーションを作成した際に取得したClient Secret。
   • CallbackURL：カスタムOAuth アプリケーションの登録時に定義したリダイレクトURI。例：https://localhost:3333

   接続すると、本製品 はデフォルトブラウザでPingOne のOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。 ドライバーはこれでOAuth プロセスを完了します。

   1. ドライバーはPingOne からアクセストークンを取得し、それを使ってデータをリクエストします。
   2. OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。

   ドライバーはアクセストークンの期限が切れると自動的にリフレッシュします。

   Web アプリケーションやヘッドレスマシン、クライアントクレデンシャルグラントを含むその他のOAuth メソッドについては、ヘルプドキュメントを参照してください。

PingOne からテーブルを選択してクエリを実行

接続を確立後、Wizard が閉じ、接続はコネクションパネルで接続が利用可能になります。テーブルをクエリしてみます。