Box への接続
Box への接続
Box への接続には、OAuth 認証標準を使用します。ユーザーアカウントまたはサービスアカウントで認証できます。組織全体のアクセススコープを本製品 に許可するには、サービスアカウントが必要です。下記で説明するとおり、本製品 はこれらの認証フローをサポートします。
ユーザーアカウント（OAuth）
AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。
デスクトップアプリケーション
CData は、OAuth デスクトップ認証を簡略化する埋め込みOAuth アプリケーションを提供します。代わりに、カスタムOAuth アプリケーションを作成することも可能です。カスタムアプリケーションの作成およびその理由については、カスタムOAuth アプリの作成 を参照してください。OAuth アクセストークンの取得およびリフレッシュ
以下を設定して、接続してください。
- InitiateOAuth：GETANDREFRESH に設定。InitiateOAuth を使うと、OAuth 交換の繰り返しや、手動でのOAuthAccessToken 設定を避けられます。
- OAuthClientId（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret（カスタムアプリのみ）：アプリの登録時に割り当てられたクライアントシークレットに設定。
- CallbackURL（カスタムアプリのみ）：アプリの登録時に定義されたリダイレクトURI に設定。次に例を示します。 https://localhost:33333
- 本製品 はBox からアクセストークンを取得し、それを使ってデータをリクエストします。
- OAuth 値はOAuthSettingsLocation で指定された場所に保存され、接続間で永続化されるようにします。
Web アプリケーション
Web アプリケーション経由で接続する場合は、Box にカスタムOAuth アプリを登録する必要があります。それから本製品 を使用してOAuth トークンの値を取得および管理します。詳しくは、カスタムOAuth アプリの作成 を参照してください。
OAuth アクセストークンの取得
次の接続プロパティを設定し、OAuthAccessToken を取得します。
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。
-
GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリ設定で指定したリダイレクトURI に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
- ステップ1でストアドプロシージャが返したURL に移動します。ログインして、Web アプリケーションを認可します。認証後、ブラウザはリダイレクトURI にリダイレクトします。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。
- GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode インプットをWEB に設定します。Verifier インプットを、リダイレクトURL のクエリ文字列のcode パラメータに設定します。
アクセストークンとリフレッシュトークンを取得した後、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることが可能です。
OAuth アクセストークンの自動リフレッシュ
本製品 がOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。
- InitiateOAuth：REFRESH に設定。
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
- OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
- OAuthSettingsLocation：本製品 がOAuth 値を保存する場所に設定。これは接続間で維持されます。
OAuth アクセストークンの手動リフレッシュ
データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。 RefreshOAuthAccessToken ストアドプロシージャを使用して、GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に手動でOAuthAccessToken をリフレッシュし、次の接続プロパティを設定します。
- OAuthClientId：アプリ設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。
最後に、OAuth リフレッシュトークンを保存し、OAuth アクセストークンの有効期限が切れた後に手動でリフレッシュできるようにします。
ヘッドレスマシン
ドライバーを設定するため、ヘッドレスマシンでユーザーアカウントにOAuth を使用します。インターネットブラウザに対応した別の端末で認証する必要があります。
- 以下のオプションから選択します。
- オプション1：後述の「Verifier code を取得および交換」に従い、OAuthVerifier 値を取得します。
- オプション2：インターネットブラウザに対応したマシンに本製品 をインストールし、通常のブラウザベースのフローで認証した後でOAuth 認証値を転送します。
- 次に、ヘッドレスマシンからアクセストークンを自動的にリフレッシュするように本製品 を設定します。
オプション1：Verifier code を取得および交換
Verifier code を取得するには、OAuth Authorization URL で認証する必要があります。
インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。
- 以下のオプションから選択します。
- 埋め込みOAuth アプリケーションを使用する場合は、GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
- カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定します。
- InitiateOAuth：OFF に設定。
- OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- ログインして、本製品 にアクセス許可を与えます。すると、リダイレクトURI にリダイレクトされます。リダイレクトURI にはcode というパラメータが付加されます。このパラメータの値を控えておきます。後ほどこれをOAuthVerifier 接続プロパティに設定します。
ヘッドレスマシンでは、次の接続プロパティを設定してOAuth 認証値を取得します。
- InitiateOAuth：REFRESH に設定。
- OAuthVerifier：これを、控えておいたverifier code（リダイレクトURI のcode パラメータの値）に設定します。
- OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
- OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。
接続をテストしてOAuth 設定ファイルを生成し、以下のプロパティを再設定して接続します。
- InitiateOAuth：REFRESH に設定。
- OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
オプション2：OAuth 設定を転送
ヘッドレスマシンでの接続に先立ち、インターネットブラウザに対応したデバイスでドライバとの接続をインストールし、作成する必要があります。上述の「デスクトップアプリケーション」の説明に従って、接続プロパティを設定します。
「デスクトップアプリケーション」の手順が完了すると、生成された認証値は、OAuthSettingsLocation で指定された場所に暗号化されて書き込まれます。デフォルトのファイル名はOAuthSettings.txt です。
接続をテストしてOAuth 設定ファイルを生成し、OAuth 設定ファイルをヘッドレスマシンにコピーします。
ヘッドレスマシンで、次の接続プロパティを設定し、データに接続します。
- InitiateOAuth：REFRESH に設定。
- OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
- OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
- OAuthSettingsLocation：ブラウザでマシンからコピーしたOAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所が本製品 に読み書きのアクセス許可を与えることを確認してください。
サービスアカウントで認証する
この方法で認証するには、AuthScheme をOAuthJWT に設定します。
サービスアカウントには、ブラウザによるユーザー認証なしのサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープを本製品 に委任することもできます。
このフローでは、OAuth アプリケーションを作成する必要があります。アプリの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるBox データに接続できます。
次の接続プロパティを設定して、接続してください。
- InitiateOAuth：GETANDREFRESH に設定。
- OAuthClientId：アプリケーション設定のクライアントId に設定。
- OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
- OAuthJWTCertType："PEMKEY_FILE" に設定。
- OAuthJWTCert：生成した.pem ファイルのパスに設定。
- OAuthJWTCertPassword：.pem ファイルのパスワードに設定。
- OAuthJWTCertSubject：証明書ストア内の1番目の証明書を選択するには、"*" に設定。
- OAuthJWTSubjectType：アプリケーション設定で選択した［Application Access Value］に応じて、［enterprise］または［user］に設定。この接続プロパティのデフォルト値は［enterprise］です。
- OAuthJWTSubject：サブジェクトタイプが［enterprise］に設定されている場合は、これをエンタープライズID に設定します。［user］に設定されている場合は、アプリのユーザーID に設定します。
- OAuthJWTPublicKeyId：アプリケーション設定の公開キーID に設定。
- 本製品 に要求されるクレームセットでJWT を作成し、サインします。
- JWT はアクセストークンと交換されます。
- OAuthSettingsLocation にOAuth 値を保存し、接続間で永続化されるようにします。
- トークンの期限が切れたときは、JWT を送り、新しいアクセストークンと交換します。