ODBC Driver for GraphQL

Build 24.0.9062

Windows DSN の構成

Microsoft ［ODBC データソースアドミニストレーター］の使用

Microsoft ODBC データソースアドミニストレーターを使ってDSN 設定を編集できます。DSN はインストールプロセス中に作成されることに注意してください。

DSN 設定を編集するには、次の手順を実行してください。

  1. スタート -> 検索 を選択し、検索ボックスにODBC データソース と入力します。
  2. アプリケーションのビット数（32-bit または64-bit）に対応するODBC アドミニストレーターのバージョンを選択してください。
  3. システムDSN タブをクリックします。
  4. システムデータソースを選択して構成をクリックします。
  5. 接続タブの情報を編集してOK をクリックします。

Note： .NET Framework 4.0 の場合、本製品 はMicrosoft Visual C++ 2015-2022 再頒布可能パッケージを配布します。.NET Framework 3.5 の場合、本製品 はMicrosoft Visual C++ 2008 再頒布可能パッケージを配布します。

レジストリへのアクセスの確保

本製品 は、接続情報をWindows レジストリに保存します。本製品 がレジストリに書き込みできるようにするには、以下のいずれかの操作を実行します。

  1. 呼び出すアプリケーションを管理者として実行する。
  2. システムDSN 経由ではなく、ユーザーDSN 経由で接続する。

GraphQL への接続

接続するには以下を設定します。

  • URL：GraphQL のURL を指定。例：https://api.example.com/graphql
  • Location：GraphQL サービスのカスタム定義スキーマを含むファイルパスに設定。

GraphQL への認証

ドライバーは次の認証をサポートします。

  • Basic
  • OAuth 1.0 & 2.0
  • OAuthPKCE
  • AWS Cognito クレデンシャル：
    • AwsCognitoSrp
    • AwsCognitoBasic

Basic

AuthScheme をBasic に設定。GraphQL のUser とPassword を指定する必要があります。

OAuth

すべてのOAuth フローでAuthScheme をOAuth に、OAuthVersion を1.0または2.0に設定する必要があります。以下のセクションは、すでに設定済みであることを前提として書かれています。

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

次の接続プロパティを設定して、接続してください。

  • OAuthRequestTokenURL：OAuth 1.0 に必要です。これはアプリケーションがリクエストトークンをリクエストするURL です。
  • OAuthAuthorizationURL：OAuth 1.0 および2.0 に必要です。これは、ユーザーがサービスにログインして、アプリケーションにアクセス許可を与えるURL です。OAuth 1.0 では、権限が与えられるとリクエストトークンが認可されます。
  • OAuthAccessTokenURL：OAuth 1.0 および2.0 に必要です。これは、アクセストークンがリクエストされるURL です。OAuth 1.0 では、認可されたリクエストトークンはアクセストークンと交換されます。
  • OAuthRefreshTokenURL：OAuth 2.0 に必要です。OAuth 2.0 では、古いトークンの期限が切れたときは、このURL でリフレッシュトークンを新しいアクセストークンと交換します。データソースによっては、アクセストークンと同じURL である場合がありますので、注意してください。
  • OAuthClientId：アプリケーション設定のクライアントId に設定。これはコンシューマーキーとも呼ばれます。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。これはコンシューマーシークレットとも呼ばれます。
  • CallbackURL：http://localhost:33333 に設定。アプリケーション設定でリダイレクトURL を指定した場合には、一致している必要があります。
接続すると、本製品 はデフォルトブラウザでOAuth エンドポイントを開きます。ログインして、アプリケーションにアクセス許可を与えます。本製品 がOAuth プロセスを完了します。

  1. コールバックURL からアクセストークンを取得し、リクエストを認証します。
  2. アクセストークンの期限が切れたときにはリフレッシュしてください。
  3. OAuth 値を保存します。これらの値は接続間で永続化されます。

ヘッドレスマシン

ヘッドレスサーバーや、本製品 がブラウザを開くことができないその他のマシンにGraphQL データソースを作成するには、別のマシンから認証を行う必要があります。認証は、2段階認証プロセスになります。

  1. 以下のオプションから選択します。
    • オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
    • オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、後述の「OAuth 設定を転送」の説明に従い、通常のブラウザベースのフローで認証後にOAuth 認証値を転送します。
  2. 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。

オプション1：Verifier code を取得および交換

ヘッドレスマシンで次のプロパティを設定します。

  • InitiateOAuth：OFF に設定。
  • OAuthClientId：アプリケーション設定のアプリケーションId に設定。
  • OAuthClientSecret：アプリケーション設定のアプリケーションシークレットに設定。

別のマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

  1. CallbackURL 入力パラメータを、アプリケーション設定で指定した正確なリダイレクトURI に設定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。
  2. OAuthVersion が1.0に設定されている場合は返されたAuthToken およびAuthKey の値を保存します。これらは次のステップで使用します。
  3. 返されたURL をブラウザで開きます。ログインして、本製品 にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
  4. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定する必要があります。

ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。

  • OAuthRequestTokenURL：OAuth 1.0 に必要です。OAuth 1.0 では、これがアプリケーションがリクエストトークンをリクエストするURL です。
  • OAuthAuthorizationURL：OAuth 1.0 および2.0 に必要です。これは、ユーザーがサービスにログインして、アプリケーションにアクセス許可を与えるURL です。OAuth 1.0 では、権限が与えられるとリクエストトークンが認可されます。
  • OAuthAccessTokenURL：OAuth 1.0 および2.0 に必要です。これは、アクセストークンがリクエストされるURL です。OAuth 1.0 では、認可されたリクエストトークンはアクセストークンと交換されます。
  • OAuthRefreshTokenURL：OAuth 2.0 に必要です。OAuth 2.0 では、古いトークンの期限が切れたときは、このURL でリフレッシュトークンを新しいアクセストークンと交換します。データソースによっては、アクセストークンと同じURL である場合がありますので、注意してください。
  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • CallbackURL：http://localhost:33333 に設定。アプリケーション設定でリダイレクトURL を指定した場合には、一致している必要があります。

データへの接続

OAuth 設定ファイルが生成されたら、次のプロパティを設定してデータに接続します。

  • OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がプロバイダーに読み書きのアクセス許可を与えることを確認してください。
  • InitiateOAuth：REFRESH に設定。

オプション2：OAuth 設定を転送

別のマシンに本製品 をインストールして認証し、結果のOAuth 値を転送する方法は次のとおりです。

セカンドマシンに、本製品 をインストールして、次の接続プロパティセットで接続します。

  • OAuthSettingsLocation：書き込み可能な場所に設定。
  • OAuthClientId：アプリケーション設定のクライアントId に設定。
  • OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
  • CallbackURL：アプリケーション設定のコールバックURL に設定。

認証する接続をテストします。生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。接続テストに成功したら、OAuth 設定ファイルをヘッドレスマシンにコピーします。ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。

  • InitiateOAuth：REFRESH に設定。
  • OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。

OAuthPKCE

NOTE：OAuth Proof Key for Code Exchange (PKCE) は、OAuth 2.0 Authorization Code フローの拡張機能です。

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

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

  • AuthScheme：OAuthPKCE に設定。
  • InitiateOAuth：GETANDREFRESH に設定すると、手動でのOAuth 交換や接続文字列のアクセストークン設定を避けられます。
  • OAuthClientId：GraphQL サービスでOAuth アプリケーションを作成する際に生成されたクライアントId に設定。
  • OAuthAuthorizationURL：GraphQL サービスの認可URL に設定。これは、ユーザーがサービスにログインして、OAuth アプリケーションにアクセス許可を与えるURL です。例：https://api.example.com/authorize
  • OAuthAccessTokenURL：GraphQL サービスのアクセストークンURL に設定。これは、アクセストークンがリクエストされるURL です。例：https://api.example.com/token
  • OAuthRefreshTokenURL：GraphQL サービスのリフレッシュトークンURL に設定。古いトークンの期限が切れたときは、このURL でリフレッシュトークンを新しいアクセストークンと交換します。データソースによっては、OAuthAccessTokenURL と同一の場合がありますので、留意してください。

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

  1. 認可コードをコールバックURL から取得します。
  2. 認可コードをアクセストークンおよびリフレッシュトークンに交換します。
  3. アクセストークンの期限が切れたときにはリフレッシュしてください。
  4. OAuth 値を保存します。これらの値は接続間で永続化されます。

AWS Cognito クレデンシャル

AWS Cognito のユーザープールに登録されたユーザーで本製品 を使用する場合は、以下のプロパティを設定して認証してください。

  • AuthScheme：AwsCognitoSrp に設定（推奨）。また、AwsCognitoBasic を使用することもできます。
  • AWSCognitoRegion：ユーザープールのリージョンに設定。
  • AWSUserPoolId：ユーザープールのId に設定。
  • AWSUserPoolClientAppId：ユーザープールのアプリクライアントId に設定。
  • AWSUserPoolClientAppSecret：ユーザープールのクライアントシークレットに設定。
  • AWSIdentityPoolId：ユーザープールとリンクしているID プールのId に設定。
  • User：ユーザープールに登録されているユーザーのユーザー名に設定。
  • Password：ユーザープールに登録されているユーザーのパスワードに設定。

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062