Windows DSN の構成

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

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

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

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

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

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

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

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

Kintone への接続

認証値に加えて、下記のパラメータを使いKintone に接続しデータを取得します。

Url：アカウントのURL。
GuestSpaceId：オプション。ゲストスペースを使用するときに設定。

Kintone への認証

Kintone は、以下の認証メソッドをサポートしています。

パスワード認証

Kintone への認証には、以下を設定する必要があります。

User：アカウントのユーザー名。
Password：アカウントのパスワード。
AuthScheme：AuthScheme をPassword に設定。

API トークン

Kintone への認証には、以下を設定する必要があります。

APIToken：API トークン。
API トークンを生成するには、特定のアプリにアクセスして歯車アイコンをクリックしてください。［設定］->［APIトークン］に移動します。［生成する］ボタンをクリックすると、API トークンが生成されます。 APIToken をカンマ区切りで複数指定することもできます。
AppId：アプリID。
AppId はkintone UI ダッシュボードの［アプリ］内に並んだ特定のアプリの番号です。 AppId をカンマ区切りで複数指定することもできます。
AuthScheme：AuthScheme をAPIToken に設定。

追加のセキュリティ

これまでに説明した認証スキームに加えて、Kintone はBasic 認証ヘッダーおよびSSL 証明書の形で追加のセキュリティを提供します。

クライアントSSL の使用

認証情報に加えて、リクエストの受け入れにSSL 証明書が必須となるようKintone を設定することができます。そのためには、次を設定してください。

SSLClientCert：SSL 証明書の証明書を含むファイル。または、クライアント証明書のための証明書ストア名。
SSLClientCertType：証明書の種類。
SSLClientCertSubject：（オプション）証明書ストアで証明書を検索する際に、ストア内でこのプロパティの値を含むサブジェクトを検索します。
SSLClientCertPassword：証明書ストアでパスワードが必要とされる際に、このプロパティを使用してパスワードを指定し、証明書ストアにアクセスできます。

Basic

Basic 認証を使用しているkintone 環境では、追加のBasic 資格情報を渡す必要があります。そのためには、次を設定してください。

BasicAuthUser：Basic ログイン名。
BasicAuthPassword：Basic パスワード。

OAuth 認証

ユーザー名やパスワードへのアクセスを保有していない場合や、それらを使いたくない場合にはOAuth ユーザー同意フローを使用します。この認証を有効にするには、すべてのOAuth フローでAuthScheme をOAuth に設定し、カスタムOAuth アプリケーションを作成する必要があります。

Note：OAuth 認証はカーソルAPI をサポートしていません。OAuth は1万行以上の取得には推奨されません。

以下のサブセクションでは、3つの一般的な認証フローでのKintone への認証について詳しく説明します。カスタムOAuth アプリケーションの作成については、カスタムOAuth アプリケーションの作成を参照してください。 Kintone で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

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

カスタムOAuth アプリケーションの資格情報を使用して認証するには、OAuth アクセストークンを取得し、更新する必要があります。これらを設定すると、接続の準備が整います。

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

OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
CallbackURL：カスタムOAuth アプリケーションの登録時に定義されたリダイレクトURI。
UseCursor：false。

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

アクセストークンの期限が切れたときは、本製品は自動でアクセストークンをリフレッシュします。

OAuth アクセストークンの自動リフレッシュ：

本製品がOAuth アクセストークンを自動的にリフレッシュするようにするには：

はじめてデータに接続する前に、次の接続パラメータを設定します。
- InitiateOAuth：REFRESH。
- OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークン。
- OAuthSettingsLocation：本製品がOAuth 値を保存する場所のパス。これは接続間で維持されます。
- UseCursor：false。
その後のデータ接続では、以下を設定します。
- InitiateOAuth
- OAuthSettingsLocation

OAuth アクセストークンの手動リフレッシュ：

OAuth アクセストークンを手動でリフレッシュするために必要な唯一の値は、OAuth リフレッシュトークンです。

ExpiresIn 期間（GetOAuthAccessToken が返す）が経過した後にOAuthAccessToken を手動でリフレッシュするには、RefreshOAuthAccessToken ストアドプロシージャを呼び出します。
次の接続プロパティを設定します。
- OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを設定します。
新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定します。これで新規接続が開かれます。

OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。

ヘッドレスマシン

ヘッドレスマシンに置かれているリソースにログインする必要がある場合は、インターネットブラウザに対応した別の端末で認証する必要があります。以下のいずれかの方法で行います。

オプション1：OAuthVerifier 値を取得します。
オプション2：インターネットブラウザに対応したマシンに本製品をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。

オプション1またはオプション2を実行後、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするようにドライバーを設定します。

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

Verifier code を取得するには、次のようにOAuth Authorization URL で認証する必要があります。

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得します。

次のプロパティを設定します。
- InitiateOAuth：OFF。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャは、カスタムOAuth アプリケーションが登録されたときに構築されたCallbackURL を返します。（カスタムOAuth アプリケーションの作成を参照してください。）

このURL をコピーして、新しいブラウザのタブに貼り付けます。
ログインして、本製品にアクセス許可を与えます。OAuth アプリケーションは、code というパラメータを付加したリダイレクトURI にリダイレクトします。このパラメータの値を控えておきます。OAuthVerifier 接続プロパティを設定するために、後で必要になります。
OAuth verifier code をOAuth リフレッシュトークンおよびアクセストークンと交換します。ヘッドレスマシンでは、OAuth 認証値を取得するには次のプロパティを設定します。
- InitiateOAuth：REFRESH。
- OAuthVerifier：控えておいたverifier code（リダイレクトURI のcode パラメータの値）。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を指定されたファイルに永続化。
- OAuthClientId：カスタムOAuth アプリケーション設定のクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーション設定のクライアントシークレット。
- UseCursor：false。
接続をテストしてOAuth 設定ファイルを生成します。
これらのプロパティを再設定すると、接続の準備が整います。
- InitiateOAuth：REFRESH。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を含むファイル。アクセストークンの自動リフレッシュを有効にするには、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
- OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
- OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
- UseCursor：false。

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

ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバーとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。

「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定されたパスに暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。

接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。

ヘッドレスマシンでデータに接続するには、次の接続プロパティを設定します。

InitiateOAuth：REFRESH
OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルへのパス。アクセストークンの自動リフレッシュを有効にするために、このファイルが本製品に読み書きのアクセス許可を与えることを確認してください。
OAuthClientId：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントId。
OAuthClientSecret：カスタムOAuth アプリケーションの登録時に割り当てられたクライアントシークレット。
UseCursor：false。

ODBC Driver for Kintone