CData Sync App は、CSV ストリーミング専用です。

このストリームファイルのコンテンツには、リモートで保存されたCSV ファイルに関連するファイル名やフォルダ名などのメタデータはすべて含まれていません。

ファイルのメタデータとファイルの実際のコンテンツの両方にアクセスする必要がある場合は、CData Sync App は、CSV ファイルがリモートで格納されているサービスの関連ファイルシステムドライバーと併せて使用する必要があります。

以下のファイルシステムドライバーが利用可能です。

• AmazonS3
• Box
• Dropbox
• FTP
• GoogleCloudStorage
• IBLCloudObjectStorage
• OneDrive
• SFTP

保存されているCSV ファイルメタデータに接続するための設定方法については、関連するCData ファイルシステムドライバーのドキュメントを参照してください。

CSV への接続を追加

1. アプリケーションコンソールで、接続ページに移動します。
2. 接続の追加パネルで、追加したい接続のアイコンを選択します。
3. CSV アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからCSV コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

CData Sync App を使用すると、ローカルおよびリモートのCSV リソースに接続できます。データソースへの接続に必要なプロパティに加えて、URI プロパティをCSV リソースの場所に設定します。

ローカルファイルへの接続

ConnectionType をLocal に設定します。ローカルファイルは、SELECT\INSERT\UPDATE\DELETE をサポートします。

URI をCSV ファイルを含むフォルダに設定します。 C:\folder1。

同じスキーマを共有する複数のCSV ファイルに接続することもできます。以下は接続文字列の例です。

URI=C:\folder; AggregateFiles=True;

個々のCSV ファイルをすべてテーブルとして公開したい場合は、このプロパティをFalse のままにしてください。

URI=C:\folder; AggregateFiles=False;

Cloud-Hosted CSV ファイルへの接続

クラウド上のファイルをINSERT、UPDATE、DELETE する必要がある場合は、そのクラウドサービスに対応するCData Sync App をダウンロードし（ストアドプロシージャでサポートされています）、ローカルファイルの対応するSync App に変更を加え、そのクラウドソース用のストアドプロシージャを使ってファイルをアップロードできます。

例えば、SharePoint 上に格納されたファイルをアップデートしたい場合、CData SharePoint Sync App のDownloadDocument プロシージャを使用してCSV ファイルをダウンロードし、CData CSV Sync App でローカルのCSV ファイルをアップデートして、最後にSharePoint Sync App のUploadDocument プロシージャを使って変更されたファイルをSharePoint にアップロードできます。

URI 接続プロパティの先頭にある一意の接頭辞は、Sync App が対象とするクラウドデータストアを識別するために使用され、残りのパスは目的のフォルダ（1ファイルにつき1テーブル）または単一ファイル（単一テーブル）への相対パスとなります。

Amazon S3

Amazon S3 に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：ConnectionType をAmazon S3 に設定。
• URI：バケットおよびフォルダ：s3://bucket1/folder1 に設定。
  • Volume およびBucket を作成し、そのバケット：s3://linktobucket にsymbolic link を作成した後、Cloudera Ozone に保存されているCSV リソースに接続することもできます。

Amazon S3 でホストされているCSV ファイルへの接続および認証について詳しくは、Amazon S3 への接続 を参照してください。

Azure Blob Storage

Azure Blob Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Azure Blob Storage に設定。
• URI：コンテナの名前およびBlob の名前に設定。例えば、azureblob://mycontainer/myblob です。

Amazon Blob Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Azure Blob Storage への接続 を参照してください。

Azure Data Lake Storage

Azure Data Lake Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Azure Data Lake Storage Gen1、Azure Data Lake Storage Gen2、またはAzure Data Lake Storage Gen2 SSL に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 に設定。次に例を示します。
  • Gen 1：adl://myfilesystem/folder1
  • Gen 2：abfs://myfilesystem/folder1
  • Gen 2 SSL：abfss://myfilesystem/folder1

Azure Data Lake Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Azure Data Lake Storage への接続 を参照してください。

Azure File Storage

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

• ConnectionType：Azure Files に設定。
• URI：Azure ファイル共有の名前とリソースの名前に設定。例：azurefile://fileShare/remotePath。
• AzureStorageAccount（必須）：Azure ファイルに紐づいているアカウントに設定。

Azure アクセスキーまたはAzure 共有アクセス署名のいずれかで認証できます。次のいずれか1つを設定してください。

• AzureAccessKey：Azure ファイルに紐づいているアクセスキーに設定。
• AzureSharedAccessSignature：Azure ファイルに紐づいている共有アクセス署名に設定。

Box

Box に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Box に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 に設定。例えば、box://folder1です。

Box でホストされているCSV ファイルへの接続および認証について詳しくは、Box への接続 を参照してください。

Dropbox

Dropbox に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Dropbox に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。例えば、dropbox://folder1 です。

Dropbox でホストされているCSV ファイルへの接続および認証について詳しくは、Dropbox への接続 を参照してください。

FTP

Sync App は、FTP サーバーへのプレーンテキスト接続およびSSL/TLS 接続の両方をサポートします。

次の接続プロパティを設定して接続します。

• ConnectionType：FTP またはFTPS のいずれかに設定。
• URI：ルートフォルダとして使用されるフォルダへのパスが付いたサーバーのアドレス に設定。例：ftp://localhost:990/folder1またはftps://localhost:990/folder1。
• User：接続するFTP(S) サーバーのユーザー名に設定。
• Password：接続するFTP(S) サーバーのパスワードに設定。

Google Cloud Storage

Google Cloud Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Google Cloud Storage に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 へのパスに設定。例えば、gs://bucket/remotePath です。

Google Cloud Storage でホストされているCSV ファイルへの接続および認証について詳しくは、Google Cloud Storage への接続 を参照してください。

Google Drive

Google Drive に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：Google Drive に設定。
• URI：ファイルシステムの名前およびCSV ファイルにコンタクトするフォルダの名前 へのパスに設定。例えば、gdrive://folder1 です。

Google Drive でホストされているCSV ファイルへの接続および認証について詳しくは、Google Drive への接続 を参照してください。

HDFS

HDFS に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：HDFS またはHDFS Secure に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。次に例を示します。
  • HDFS：webhdfs://host:port/remotePath
  • HDFS Secure：webhdfss://host:port/remotePath
  • Cloudera Ozone（HttpFS ゲートウェイ経由）： webhdfs://<Ozone server>:<port>/user/myuser
    • Ozone に保存されているCSV ファイルにアクセスするには、Kerberos 認証を使用する必要があります。
    • Ozone クラスタにOzone 718.2.x があることを確認してください。
    • Cloudera Manager version 7.10.1 が必要です。

HDFS データソースへの接続に使用できる認証方法は、匿名認証とKerberos 認証の2つがあります。

匿名認証

状況によっては、認証接続プロパティなしでHDFS に接続できます。 そのためには、AuthScheme プロパティをNone（デフォルト）に設定します。

Kerberos を使用した認証

認証資格情報が必要な場合、認証にKerberos を使用することができます。 Kerberos で認証する方法についての詳細は、Kerberos の使用 を参照してください。

HTTP Streams

HTTP streams に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：HTTP またはHTTPS に設定。
• URI：HTTP(S) stream のURI に設定。次に例を示します。
  • HTTP： http://remoteStream
  • HTTPS： https://remoteStream

HTTP Streams でホストされているCSV ファイルへの接続および認証について詳しくは、HTTP Streams への接続 を参照してください。

IBM Cloud Object Storage

IBM Cloud Object Storage に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：IBM Object Storage Source に設定。
• URI：バケットおよびフォルダに設定。例えば、ibmobjectstorage://bucket1/remotePath です。
• Region：このプロパティをIBM インスタンスリージョンに設定。例：eu-gb.

IBM Cloud Object Storage でホストされているCSV ファイルへの接続および認証について詳しくは、IBM Object Storage への接続 を参照してください。

OneDrive

OneDrive に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：OneDrive に設定。
• URI：CSV ファイルを含むフォルダへのパス に設定。例えば、onedrive://remotePath です。

OneDrive でホストされているCSV ファイルへの接続および認証について詳しくは、OneDrive への接続 を参照してください。

OneLake

OneLake に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：OneLake に設定。
• URI：ワークスペース名、アイテム名、アイテムタイプの順に設定。オプションで、ルートフォルダとして使用するフォルダパスを含めます。例：onelake://Workspace/Test.LakeHouse/Files/CustomFolder。

OneLake でホストされているCSV ファイルへの接続および認証について詳しくは、OneLake への接続 を参照してください。

Oracle Cloud Storage

HMAC で認証するには、次のプロパティを設定します。

• ConnectionType：ConnectionType をOracle Cloud Storage に設定。
• URI：バケットおよびフォルダ：os://bucket/remotePath に設定。
• AccessKey： Oracle Cloud のAccess Key に設定。
• SecretKey：Oracle Cloud のSecret Key に設定。
• OracleNamespace：Oracle cloud のnamespace に設定。
• Region（オプション）：S3ライクなWeb サービスのホスティングリージョンに設定。

SFTP

SFTP に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：SFTP に設定。
• URI：これをサーバーのアドレスに設定し、パスを続けて指定します。例えば、sftp://server:port/remotePath です。

SFTP でホストされているCSV ファイルへの接続および認証について詳しくは、SFTP への接続 を参照してください。

SharePoint Online

SharePoint Online に格納されているCSV リソースを識別するために以下を設定します。

• ConnectionType：SharePoint REST またはSharePoint SOAP に設定。
• URI：CSV ファイルを含むドキュメントライブラリ に設定。次に例を示します。
  • SharePoint Online REST： sprest://remotePath
  • SharePoint Online SOAP： sp://remotePath

SharePoint Online でホストされているCSV ファイルへの接続および認証について詳しくは、SharePoint Online への接続 を参照してください。

その他のソースへの接続システムストリーム

システムストリームへの読み出し/書き込みも可能です。ExtendedProperties 接続プロパティを使用して、コードからストリームを参照します。

セキュアなCSV への接続

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL/TLS のネゴシエーションを試みます。別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

CSV への接続

以下は、Sync App のデフォルトのデータモデリング設定を使用したCSV ファイルまたはストリームへの接続文字列の例です。

動的なスキーマ検出

次のプロパティを設定して、Sync App が接続時に自動的にCSV をテーブルとしてモデル化する方法を制御します。

• IncludeColumnHeaders：指定したファイルの一行目からカラム名を取得するように設定します（デフォルト）。そうでない場合は、カラム名はカラム番号になります。
• FMT：テキストファイルのパースに使用する形式に設定します。CsvDelimited（デフォルト）またはTabDelimited。
• IncludeFiles：テーブルとしてモデル化されたファイル一式に含めるファイル拡張子のカンマ区切りリストに設定します。（デフォルトでは.txt、.tab、および.csv ファイルがモデル化されます。）
• RowScanDepth：指定した深さまで行をスキャンして、データ型を自動的に決定するように設定します。

ローカルCSV で作業する場合は、Microsoft Jet ドライバーと互換性のあるSchema.ini ファイルを使用してカラムとデータ型を定義することもできます。Schema.ini の使用 を参照してください。

スキーマのカスタマイズ

カラムのデータ型およびスキーマのその他の側面をカスタマイズするには、スキーマを静的なコンフィギュレーションファイルに保存できます。コンフィギュレーションファイルはシンプルな形式となっており、簡単に拡張できます。Sync App スキーマの拡張について詳しくは、スキーマファイルの生成 を参照してください。

サブフォルダへのアクセス

次のプロパティを設定して、サブフォルダをビューとしてモデル化します。

• IncludeSubdirectories：ネストされたフォルダからファイルやSchema.ini を読み出すように設定します。名前衝突が起こった場合は、テーブル名の前にアンダースコアで区切られたフォルダ名が付けられます。デフォルト値はfalse です。
• DirectoryRetrievalDepth：IncludeSubdirectories が設定されている場合に、再帰的にスキャンするサブフォルダの数を設定します。デフォルトでは、Sync App はすべてのサブフォルダをスキャンします。

IncludeSubdirectories が設定されている場合、自動的に検出されるテーブル名は以下の規則に従います。

接続の前に

AWS キーを取得

1. IAM コンソールにサインインします。
2. ナビゲーションペインでユーザーを選択します。
3. ユーザーのアクセスキーを作成または管理するには、ユーザーを選択してからセキュリティ認証情報タブを選択します。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択します。
3. 表示されたメニューでMy Security Credentials を選択します。
4. ルートアカウントのアクセスキーを管理または作成するには、Continue to Security Credentials をクリックし、［Access Keys］セクションを展開します。

Amazon S3 への接続

データへの接続には、以下を設定してください。

• AWSRegion：CSV データがホストされているリージョンに設定。
• StorageBaseURL（オプション）：ベースとなるS3 サービスのURL が"amazonaws.com" と異なる場合のみ、そのURL を指定します。必ず完全なURL を指定してください。例：http://127.0.0.1:9000

Amazon S3 への認証

CSV への接続に使用できる認証方法は、以下を含めいくつかあります。

• ルートクレデンシャル
• AWS ロール（EC2 インスタンスまたはルート認証の指定による）としてのAWS ロール
• SSO（ADFS、Okta、PingFederate）
• 一時クレデンシャル
• クレデンシャルファイル

ルートクレデンシャル

アカウントのルートクレデンシャルで認証するには、次の設定パラメータを設定します。

• AuthScheme：AwsRootKeys。
• AWSAccessKey：AWS ルートアカウントに紐づいているアクセスキー。
• AWSSecretKey：AWS ルートアカウントに紐づいているシークレットキー。

Note： この認証スキームの使用は、簡単なテスト以外ではAmazon では推奨されていません。アカウントのルート認証情報はユーザーの完全な権限を持つため、これが最も安全性の低い認証方法になります。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

EC2 Instances

AuthScheme をAwsEC2Roles に設定します。

EC2 インスタンスからSync App を使用していて、そのインスタンスにIAM ロールが割り当てられている場合は、 認証にIAM ロールを使用できます。Sync App は自動的にIAM ロールの認証情報を取得し、それらを使って認証するため、AWSAccessKey およびAWSSecretKey を指定する必要はありません。

認証にIAM ロールも使用している場合は、さらに以下を指定する必要があります。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

IMDSv2 サポート

CSV Sync App は、IMDSv2 をサポートしています。IMDSv1 とは異なり、新バージョンでは認証トークンが必須です。エンドポイントおよびレスポンスは、両バージョンで同じです。

IMDSv2 では、CSV Sync App はまずIMDSv2 メタデータトークンの取得を試み、それを使用してAWS メタデータエンドポイントを呼び出します。トークンを取得できない場合、Sync App はIMDSv1 を使用します。

AWS Web Identity

AuthScheme をAwsWebIdentity に設定します。

Web ID でロールを割り当てられるように構成されたコンテナ（OpenID Provider を持つEKS クラスタ内のPod など）からSync App を使用する場合、またはIAM ロールに関連付けられたWeb ID プロバイダーで認証してID トークンを取得する場合は、Web ID トークンとIAM ロールの情報を一時的なセキュリティ認証情報と交換し、AWS サービスを認証してアクセスすることができます。コンテナの環境変数にAWS_ROLE_ARN とAWS_WEB_IDENTITY_TOKEN_FILE が指定されている場合、Sync App は自動的に認証情報を取得します。または、AWSRoleARN とAWSWebIdentityToken の両方を指定し、AssumeRoleWithWebIdentity API 操作を実行して認証することもできます。

AWS IAM Roles

AuthScheme をAwsIAMRoles に設定します。

多くの場合、認証にはAWS ルートユーザーのダイレクトなセキュリティ認証情報ではなく、IAM ロールを使用することをお勧めします。AWS ルートユーザーのAWSAccessKey およびAWSSecretKey を指定している場合、ロールは使用できない場合があります。

AWS ロールとして認証するには、次のプロパティを設定します。

• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を 取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

ADFS

ADFS に接続するには、AuthScheme をADFS に設定し、次のプロパティを設定します。

• User：ADFS ユーザー。
• Password：ADFS ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

ADFS への認証を行うには、次のSSOProperties を設定します。

• RelyingParty：ADFS サーバーのRelying Party Identifier の値。

接続文字列の例：

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';SSOProperties='RelyingParty=https://saml.salesforce.com';

ADFS 統合

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じ手順を実行してください。

Okta

Okta に接続するには、AuthScheme をOkta に設定し、次のプロパティを設定します。

• User：Okta ユーザー。
• Password：Okta ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。

Okta クライアントリクエストコンテキストをオーバーライドする信頼されたアプリケーションまたはプロキシを使用する場合、またはMFA を設定している場合は、Okta を使用して認証するためにSSOProperties を組み合わせて使用する必要があります。必要に応じて、以下のいずれかを設定します。

• APIToken：Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合、これを顧客がOkta 組織で作成したAPI Token に設定します。
• MFAType：MFA フローを設定した場合、次の対応するタイプのいずれかに設定します：OktaVerify、Email、またはSMS。
• MFAPassCode：MFA フローを設定した場合は、有効なパスコードに設定します。
  これを空欄または無効な値に設定した場合、Sync App はユーザーのデバイスまたはE メールにワンタイムパスワードチャレンジを発行します。パスコードを受信後、取得したワンタイムパスワードをMFAPassCode 接続プロパティに設定する接続を再度開きます。
• MFARememberDevice：デフォルトはTrue です。Okta は、MFA が必要な場合にデバイスを記憶させることをサポートします。設定された認証ポリシーに従ってデバイスの記憶が許可されている場合、Sync App はMFA 認証の有効期間を延長するデバイストークンを送信します。MFA を記憶させない場合は、この 変数をFalse に設定してください。

接続文字列の例：

AuthScheme=Okta;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;

PingFederate に接続するには、AuthScheme をPingFederate に設定し、次のプロパティを設定します。

• User：PingFederate ユーザー。
• Password：PingFederate ユーザーのパスワード。
• SSOLoginURL：SSO プロバイダーのログインURL。
• AWSRoleARN（オプション）：複数のロールARN がある場合は、認可に使用するARN を指定します。
• AWSPrincipalARN（オプション）：複数のプリンシパルARN がある場合は、認可に使用するARN を指定します。
• SSOExchangeUrl: The Partner Service Identifier URI configured in your PingFederate server instance under: SP Connections > SP Connection > WS-Trust > Protocol Settings. This should uniquely identify a PingFederate SP Connection, so it is a good idea to set it to your AWS SSO ACS URL. You can find it under AWS SSO > Settings > View Details next to the Authentication field.
• SSOProperties（オプション）：Amazon S3へのリクエストにユーザー名とパスワードを認可ヘッダーとして含める場合は、Authscheme=Basic。

SSOLoginURL 用の相互SSL 認証（WS-Trust STS エンドポイント）を有効化するには、次の SSOProperties を設定します。

• SSLClientCert
• SSLClientCertType
• SSLClientCertSubject
• SSLClientCertPassword

接続文字列の例：

authScheme=pingfederate;SSOLoginURL=https://mycustomserver.com:9033/idp/sts.wst;SSOExchangeUrl=https://us-east-1.signin.aws.amazon.com/platform/saml/acs/764ef411-xxxxxx;user=admin;password=PassValue;AWSPrincipalARN=arn:aws:iam::215338515180:saml-provider/pingFederate;AWSRoleArn=arn:aws:iam::215338515180:role/SSOTest2;

一時クレデンシャル

一時クレデンシャルで認証するには、次を設定します。

• AuthScheme：AwsTempCredentials。
• AWSAccessKey：ロールを担うIAM ユーザーのアクセスキー。
• AWSSecretKey：ロールを担うIAM ユーザーのシークレットキー。
• AWSSessionToken：一時クレデンシャルと共に提供されるAWS のセッショントークン。 詳細はAWS Identity and Access Management ユーザーガイド を参照してください。

Sync App は、一時クレデンシャルの有効期間中、長期的な認証情報（IAM ユーザー認証情報など）によって提供されるものと同じ権限を使用してリソースをリクエストできるようになりました。

一時クレデンシャルおよびIAM ロールの両方を使用して認証するには、上記のすべてのパラメータを設定し、さらに以下のパラメータを指定します。

• AWSRoleARN：認証したいロールのRole ARN を指定。これにより、Sync App は指定されたロールの認証情報を取得しようと試みます。
• AWSExternalId（オプション）：別のAWS アカウントでロールを引き受ける場合にのみ必要です。

多要素認証が必要な場合は、以下を指定します。

• CredentialsLocation：MFA クレデンシャルが保存される設定ファイルの場所。詳しくは、接続文字列オプションのCredentials File Location のページを参照してください。
• MFASerialNumber：MFA デバイスが使用されている場合は、そのシリアル番号。
• MFAToken：MFA デバイスから利用できる一時トークン。

Note： 一時的な認証情報の有効期間（デフォルトは3600秒）を制御するには、TemporaryTokenDuration プロパティを設定します。

クレデンシャルファイル

認証にはクレデンシャルファイルを使用することができます。AccessKey/SecretKey 認証、一時クレデンシャル、ロール認証、またはMFA に関連するすべての設定が使用できます。 これを行うには、次のプロパティを設定して認証します。

• AuthScheme：AwsCredentialsFile。
• AWSCredentialsFile：クレデンシャルファイルの場所。
• AWSCredentialsFileProfile（オプション）：指定したクレデンシャルファイルから使用するプロファイルの名前。指定しない場合は、default という名前のプロファイルが使用されます。

Azure AD

この設定では、2つの別個のAzure AD アプリケーションが必要になります。

• シングルサインオンに使用される"CSV" アプリケーション。
• "CSV" アプリケーションに対するuser_impersonation 権限を持つカスタムOAuth アプリケーション。（カスタムOAuth アプリの作成 を参照してください。）

Azure AD に接続するには、AuthScheme をAzureAD に設定し、次のプロパティを設定します。

• OAuthClientId：アプリ登録の概要セクションにリストされている、コネクタアプリケーションのアプリケーションId。
• OAuthClientSecret：コネクタアプリケーションのクライアントシークレット値。新しいクライアントシークレットを作成すると、Azure AD にこれが表示されます。
• CallbackURL：コネクタアプリケーションのリダイレクトURI。例： https://localhost:33333。

Azure AD を認証するには、これらのSSOProperties を設定します。

• Resource：アプリ登録の概要セクションにリストされている、CSV アプリケーションのアプリケーションId URI。ほとんどの場合、これはカスタムCSV ドメインのURL です。
• AzureTenant：アプリケーションが登録されているAzure AD テナントのId。

接続文字列の例：

AuthScheme=AzureAD;OAuthClientId=3ea1c786-d527-4399-8c3b-2e3696ae4b48;OauthClientSecret=xxx;CallbackUrl=https://localhost:33333;SSOProperties='Resource=https://signin.aws.amazon.com/saml;AzureTenant=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx';

接続の前に

AzureBlob ユーザーの認証情報を取得するには、以下の手順に従ってください。

1. ルートアカウントの認証情報を使用してAzure ポータル にサインインします。
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定でアクセスキーをクリックします。
4. ページ上にストレージアカウント名とキーが表示されます。

Azure Blob Storage への接続

AzureStorageAccount をAzure Blob Storage アカウント名に設定します。

Azure Blob Storage への認証

Azure Blob Storage への認証には、アクセスキー、Shared Access Signature（SAS）、Azure AD ユーザー、Azure MSI、またはAzure サービスプリンシパルを使用できます。

アクセスキー

Azure アクセスキーで認証するには、以下のように設定します。

• AuthScheme：AccessKey に設定。
• AzureAccessKey：Azure Blob Storage アカウントに紐づいているストレージキーに設定。

共有アクセス署名（SAS）

• AuthScheme：AzureStorageSAS に設定。
• AzureSharedAccessSignature：Azure Blob Storage アカウントに紐づいているSAS に設定。

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定でShared Access Signature をクリックします。
4. アクセス許可を設定します。
5. トークンの有効期限を指定します。
6. SAS の生成をクリックし、生成された共有アクセス署名をコピーします。
7. AzureSharedAccessSignature を前のステップの共有アクセス署名に設定します。

AzureAD ユーザー

AuthScheme は、すべてのユーザーアカウントフローでAzureAD に設定する必要があります。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

クライアントシークレット

次の接続プロパティを設定します。

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

次の接続プロパティを設定します。

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Azure MSI

Azure Data Lake Storage のアクセス許可を持つAzure VM で接続する場合は、AuthScheme をAzureMSI に設定します。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。認証するには以下のように設定します。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

カスタムAzureAD アプリケーションには、AzureAD とAzure サービスプリンシパルを使用するAzureAD の2種類があります。いずれもOAuth ベースです。

カスタムアプリケーションを作成するタイミング

以下の場合はユーザー自身のAzureAD アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムAzureAD アプリケーション

カスタムAzureAD アプリの作成

下記の手順に従って、アプリケーションのAzureAD 値、OAuthClientId およびOAuthClientSecret を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリケーション名を入力し、目的のテナント設定を選択します。 Azure Active Directory でカスタムAzureAD アプリケーションを作成する場合、アプリケーションをシングルテナントまたはマルチテナントに定義できます。デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Sync App への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。アプリケーションが個人使用のみの場合は、［この組織ディレクトリ内のアカウントのみ］で十分です。アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。
5. リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。あるいは、任意の別のポートを指定して、CallbackURL を定義した正確なリプライURL に設定します。
6. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が自動的に開きます。OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
7. ［証明書とシークレット］セクションに移動して、アプリケーションの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書を使用する方法です。
   • オプション1：証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2：新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。 これは、OAuthClientSecret として必要になります。
8. API のアクセス許可 -> アクセス許可の追加をクリックします。ユーザーコンテキストなしでアプリを接続する予定の場合は、アプリケーションの許可（OAuthGrantType = CLIENT）を選択します。それ以外の場合は、委任されたアクセス許可を使用します。
9. 変更を保存します。
10. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを選択した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパルカスタムアプリケーション

Azure サービスプリンシパルを使用して認証する場合は、カスタムAzureAD アプリケーションと必要なリソースにアクセスできるサービスプリンシパル両方の作成が必要です。次の手順に従って、カスタムAzureAD アプリケーションを作成し、Azure サービスプリンシパル認証用の接続プロパティを取得します。

Azure サービスプリンシパルでカスタムAzureAD アプリを作成

下記の手順に従って、アプリケーションのAzureAD 値を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリ名を入力し、任意のAzure AD ディレクトリ - マルチテナントを選択します。そして、リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。
5. アプリ作成後に、［概要］セクションに表示されているアプリケーション（クライアント）Id の値をコピーします。この値はOAuthClientId として使用されます。
6. ［証明書とシークレット］セクションに移動して、アプリの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書による方法です。
   • オプション1 - 証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2 - 新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。これは、OAuthClientSecret として使用します。
7. 認証タブで、必ずアクセストークン（暗黙的なフローに使用）を選択してください。

Azure Data Lake Storage への接続

AzureStorageAccount をAzure Data Lake Storage アカウント名に設定します。

Azure Data Lake Storage への認証

Azure Data Lake Storage への認証には、アクセスキー、Shared Access Signature（SAS）、Azure AD ユーザー、Azure MSI、またはAzure サービスプリンシパルを使用できます。

アクセスキー

Azure アクセスキーで認証するには、以下のように設定します。

• AuthScheme：AccessKey に設定。
• AzureAccessKey：Azure Data Lake Storage アカウントに紐づいているストレージキーに設定。

Shared Access Signature（SAS）

• AuthScheme：AzureStorageSAS に設定。
• AzureSharedAccessSignature：Azure Blob Storage アカウントに紐づいているSAS に設定。

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定でShared Access Signature をクリックします。
4. アクセス許可を設定します。
5. トークンの有効期限を指定します。
6. SAS の生成をクリックし、生成された共有アクセス署名をコピーします。
7. AzureSharedAccessSignature を前のステップの共有アクセス署名に設定します。

AzureAD ユーザー

AuthScheme は、すべてのユーザーアカウントフローでAzureAD に設定する必要があります。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

クライアントシークレット

次の接続プロパティを設定します。

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

次の接続プロパティを設定します。

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Azure MSI

Azure Data Lake Storage のアクセス許可を持つAzure VM で接続する場合は、AuthScheme をAzureMSI に設定します。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。認証するには以下のように設定します。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

カスタムAzureAD アプリケーションには、AzureAD とAzure サービスプリンシパルを使用するAzureAD の2種類があります。いずれもOAuth ベースです。

カスタムアプリケーションを作成するタイミング

以下の場合はユーザー自身のAzureAD アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムAzureAD アプリケーション

カスタムAzureAD アプリの作成

下記の手順に従って、アプリケーションのAzureAD 値OAuthClientId およびOAuthClientSecret を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリケーション名を入力し、目的のテナント設定を選択します。 Azure Active Directory でカスタムAzureAD アプリケーションを作成する場合、アプリケーションをシングルテナントまたはマルチテナントに定義できます。デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Sync App への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。アプリケーションが個人使用のみの場合は、［この組織ディレクトリ内のアカウントのみ］で十分です。アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。
5. リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。あるいは、任意の別のポートを指定して、CallbackURL を定義した正確なリプライURL に設定します。
6. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が自動的に開きます。OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
7. ［証明書とシークレット］セクションに移動して、アプリケーションの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書を使用する方法です。
   • オプション1：証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2：新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。 これは、OAuthClientSecret として必要になります。
8. API のアクセス許可 -> アクセス許可の追加をクリックします。ユーザーコンテキストなしでアプリを接続する予定の場合は、アプリケーションの許可（OAuthGrantType = CLIENT）を選択します。それ以外の場合は、委任されたアクセス許可を使用します。
9. 変更を保存します。
10. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを選択した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパルカスタムアプリケーション

Azure サービスプリンシパルを使用して認証する場合は、カスタムAzureAD アプリケーションと必要なリソースにアクセスできるサービスプリンシパル両方の作成が必要です。次の手順に従って、カスタムAzureAD アプリケーションを作成し、Azure サービスプリンシパル認証用の接続プロパティを取得します。

Azure サービスプリンシパルでカスタムAzureAD アプリを作成

下記の手順に従って、アプリケーションのAzureAD 値を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリ名を入力し、任意のAzure AD ディレクトリ - マルチテナントを選択します。そして、リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。
5. アプリ作成後に、［概要］セクションに表示されているアプリケーション（クライアント）Id の値をコピーします。この値はOAuthClientId として使用されます。
6. ［証明書とシークレット］セクションに移動して、アプリの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書による方法です。
   • オプション1 - 証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2 - 新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。これは、OAuthClientSecret として使用します。
7. 認証タブで、必ずアクセストークン（暗黙的なフローに使用）を選択してください。

Box への接続

Box への接続には、OAuth 認証標準を使用します。ユーザーアカウントまたはサービスアカウントで認証できます。組織全体のアクセススコープをSync App に許可するには、サービスアカウントが必要です。下記で説明するとおり、Sync App はこれらの認証フローをサポートします。

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

サービスアカウントで認証する

この方法で認証するには、AuthScheme をOAuthJWT に設定します。

サービスアカウントには、ブラウザによるユーザー認証なしのサイレント認証があります。また、サービスアカウントを使用して、エンタープライズ全体のアクセススコープをSync App に委任することもできます。

このフローでは、OAuth アプリケーションを作成する必要があります。アプリの作成および認可については、カスタムOAuth アプリの作成 を参照してください。これでサービスアカウントにアクセス権があるBox データに接続できます。

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

• 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 に設定。

カスタムOAuth アプリケーションの作成

独自の OAuth アプリケーション認証情報を使用することもできます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

手順

Box エンタープライズ管理コンソールで：

1. Box 開発者ダッシュボード にログインします。
2. アプリの新規作成をクリックします。
3. 必要に応じて、基本的なアプリケーション情報を指定します。
4. アプリケーションの種類を指定します（例：カスタムアプリ）。
5. 認証メソッドで、ユーザー認証（OAuth 2.0）を選択します。
6. リダイレクトURI を設定します。
   • である場合、リダイレクトURI をhttp://localhost:33333か別のポート番号に設定してください。
7. アプリの作成をクリックします。
8. 次に、公開キーと秘密キーのペアを作成します。
   • 開発者コンソールからキーペアを作成するには：
     1. 開発者コンソールの「構成」タブに移動します。
     2. 公開キーの追加と管理までスクロールダウンします。
     3. 公開 / 秘密キーペアを生成をクリックします。Box はJSON ファイル形式でキーペアを作成し、そのファイルをデスクトップにダウンロードします。 その後、そのファイルをアプリケーションコードに移動させることができます。

        Note： Box は、セキュリティ上の理由から秘密キーのバックアップを行いません。公開 / 非公開JSON ファイルのバックアップに注意してください。秘密キーを忘れた場合は、キーペア全体をリセットする必要があります。

   • キーペアを手動で追加するには：
     1. ターミナルウィンドウを開き、以下のOpenSSL コマンドを実行します。
        

        openssl genrsa -des3 -out private.pem 2048
        openssl rsa -in private.pem -outform PEM -pubout -out public.pem

        Note： Windows 環境でOpenSSL を実行するには、Cygwin パッケージをインストールします。

     2. 開発者コンソールで、先ほど作成したカスタムOAuth アプリケーションの構成タブに移動します。
     3. 公開キーの追加と管理までスクロールダウンします。
     4. 公開キーを追加をクリックします。
     5. Verify and Save をクリックします。
9. カスタムアプリケーションを使用する前に、Box 管理者はBox 管理コンソール内でそのアプリケーションを承認する必要があります。
   1. 開発者コンソール内のアプリケーションに移動します。
   2. 承認タブをクリックします。
   3. Enterprise へのアクセス権限に対する承認を得るためにアプリを送信というプロンプトが表示されたら、確認して送信をクリックします。
      Box エンタープライズ管理者が申請を承認します。
10. 最後に、カスタムOAuth アプリケーションが要求するユーザー権限の範囲を選択します。

アプリケーションの作成と登録が完了したら、メインメニューから設定をクリックして設定にアクセスできます。 表示されるリダイレクトURI、クライアントID およびクライアントシークレットを控えておきます。これらの値は後で必要になります。

JWTアクセススコープの変更時

JWT アクセススコープを変更する場合は、エンタープライズ管理コンソールでアプリケーションを再認可する必要があります。

1. メインメニューのアプリをクリックします。
2. JWT アプリケーション名の横にある省略記号ボタンを選択します。
3. メニューのReauthorize App を選択します。

Dropbox への接続

Dropbox はOAuth 認証標準を利用しています。

Dropbox OAuth スコープ

CData の埋め込みOAuth アプリを使うか、カスタムOAuth アプリの作成 のどちらかを選択してください。

埋め込みアプリは以下のスコープを含みます。

• account_info.read
• file_requests.read
• files.content.read
• files.content.write
• files.metadata.read
• sharing.read
• sharing.write

カスタムOAuth アプリケーションを作成するタイミング

以下の場合はユーザー自身のOAuth アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムOAuth アプリの作成

1. Dropbox 開発者ダッシュボード にログインして［アプリを作成］をクリックします。Dropbox API を選択します。アプリへのアクセスタイプはFull Dropbox を選択します。
2. アプリを作成すると、アプリ設定を表示するメインメニューからConfiguration を見ることができます。
3. アプリのSettings タブで、のちのSync App 設定のためにApp key とApp secret の値をメモしておきます。
4. リダイレクトURI を設定し、後でSync App を設定するために指定された値を保存します。
   • を設定する際、リダイレクトURI をhttp://localhost:33333か別のポート番号に設定してください。
5. アプリのPermissions タブで、アプリが要求するユーザーのアクセス許可の範囲を選択します。

CSV のアプリ設定でこれ以上値を指定する必要はありません。

Google Cloud Storage への接続

ProjectId プロパティを接続するプロジェクトのId に設定します。

Google Cloud Storage への認証

Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Cloud Storage の利用可能な認証スキームについて説明します。

• ユーザーアカウント（OAuth）
• サービスアカウント（OAuthJWT）
• GCP インスタンスアカウント

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

Web アプリケーション

OAuth アクセストークンの取得

次の接続プロパティを設定し、OAuthAccessToken を取得します。

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

続いてストアドプロシージャを呼び出し、OAuth 交換を完了します。

1. GetOAuthAuthorizationURL ストアドプロシージャを呼び出します。CallbackURL インプットをアプリケーション設定で指定したコールバックURL に設定します。ストアドプロシージャがOAuth エンドポイントのURL を返します。
2. ステップ1でストアドプロシージャが返したURL に移動します。カスタムOAuth アプリケーションにログインして、Web アプリケーションを認可します。認証されると、ブラウザはコールバックURL にリダイレクトします。
3. GetOAuthAccessToken ストアドプロシージャを呼び出します。AuthMode をWEB に、Verifier インプットをコールバックURL のクエリ文字列の"code" パラメータに設定します。

アクセストークンとリフレッシュトークンを取得すると、データに接続し、OAuth アクセストークンを自動または手動でリフレッシュすることができるようになります。

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

ドライバーがOAuth アクセストークンを自動的にリフレッシュするようにするには、最初のデータ接続で次のように設定します。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：アプリケーション設定のクライアントシークレットに設定。
• OAuthAccessToken：GetOAuthAccessToken によって返されたアクセストークンに設定。
• OAuthRefreshToken：GetOAuthAccessToken によって返されたリフレッシュトークンに設定。
• OAuthSettingsLocation：Sync App がOAuth トークン値を保存する場所に設定。これは接続間で維持されます。

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

データ接続時に手動でOAuth アクセストークンをリフレッシュするために必要な値は、OAuth リフレッシュトークンのみです。

GetOAuthAccessToken によって返されたExpiresIn パラメータ値が経過した後に、RefreshOAuthAccessToken ストアドプロシージャを使用し、手動でOAuthAccessToken をリフレッシュします。次の接続プロパティを設定します。

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

次に、RefreshOAuthAccessToken を呼び出し、OAuthRefreshToken にGetOAuthAccessToken によって返されたOAuth リフレッシュトークンを指定します。新しいトークンが取得できたら、OAuthAccessToken プロパティにRefreshOAuthAccessToken によって返された値を設定し、新しい接続をオープンします。

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

ヘッドレスマシン

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

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

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

インターネットブラウザに対応したマシンから認証してOAuthVerifier 接続プロパティを取得する方法は次のとおりです。

1. 以下のオプションから選択します。
   • 埋め込みOAuth アプリケーションを使用する場合は、Google Cloud Storage OAuth エンドポイント をクリックし、ブラウザでエンドポイントを開きます。
   • カスタムOAuth アプリケーションを使用するには、以下のプロパティを設定し、認証URL を作成します。
     • InitiateOAuth：OFF に設定。
     • OAuthClientId：アプリケーションの登録時に割り当てられたクライアントId に設定。
     • OAuthClientSecret：アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
     次に、適切なCallbackURL を指定してGetOAuthAuthorizationURL ストアドプロシージャを呼び出します。ストアドプロシージャによって返されたURL をブラウザで開きます。
2. ログインして、Sync App にアクセス許可を与えます。すると、verifier code を含むコールバックURL にリダイレクトされます。
3. verifier code の値を保存します。後ほどこれをOAuthVerifier 接続プロパティに設定します。

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

• InitiateOAuth：REFRESH に設定。
• OAuthVerifier：verifier code に設定。
• OAuthClientId：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）カスタムOAuth アプリケーション設定のクライアントシークレットに設定。
• OAuthSettingsLocation：これを設定すると、暗号化されたOAuth 認証値が指定された場所に永続化されます。

OAuth 設定ファイルが生成されたら、以下のように接続プロパティをリセットする必要があります。

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：暗号化されたOAuth 認証値を含む場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がSync App に読み書きのアクセス許可を与えることを確認してください。

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

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

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

接続が正常にテストされたら、OAuth 設定ファイルをヘッドレスマシンにコピーします。

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

• InitiateOAuth：REFRESH に設定。
• OAuthClientId：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントId に設定。
• OAuthClientSecret：（カスタムアプリのみ）アプリケーションの登録時に割り当てられたクライアントシークレットに設定。
• OAuthSettingsLocation：OAuth 設定ファイルの場所に設定。アクセストークンの自動リフレッシュを有効にするために、この場所がSync App に読み書きのアクセス許可を与えることを確認してください。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

カスタムOAuth アプリケーションの作成

（OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「CSV への接続」の デスクトップ認証セクションを参照してください。）

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成（独自のOAuth アプリケーションクレデンシャルを使用）することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

以下のセクションでは、Directory API を有効化し、ユーザーアカウント（OAuth）およびサービスアカウント（OAuth / JWT）用のカスタムOAuth アプリケーションを作成する方法について説明します。

Cloud Storage API を有効化

1. Google Cloud Console に移動します。
2. 左側のナビゲーションメニューからライブラリを選択します。API ライブラリページが開きます。
3. 検索ボックスに、"Cloud Storage API" と入力し、検索結果からCloud Storage API を選択します。
4. Cloud Storage API ページで、有効にするをクリックします。

OAuth アプリケーションの作成

ユーザーアカウント（OAuth）

AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 （デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。）

以下の手順に従います。

1. Google Cloud Console に移動します。
2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
3. 左側のナビゲーションメニューで、認証情報を選択します。
4. このプロジェクトに同意画面がまだ設定されていない場合は、同意画面を設定 をクリックして作成します。Google Workspace アカウントを使用しない場合、User Type が外部の同意画面の作成に制限され、ユーザーサポートメールとデベロッパーの連絡先情報を指定する必要があります。 追加情報は任意です。
5. 認証情報ページで認証情報を作成 -> OAuth クライアントID を選択します。
6. アプリケーションの種類メニューでウェブアプリケーションを選択します。
7. カスタムOAuth アプリケーションの名前を指定します。
8. 承認済みのリダイレクトURI の下にあるURI を追加をクリックし、リダイレクトURI を入力します。
9. Enter をクリックし、続けて作成をクリックします。Cloud コンソールは認証情報ページに戻ります。
   ウィンドウが開き、クライアントId とクライアントシークレットが表示されます。
10. 後でOAuthClientId とOAuthClientSecret として使用するために、クライアントId とクライアントシークレットを記録しておきます。

Note： クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。

サービスアカウント（OAuthJWT）

新しいサービスアカウントを作成するには：

1. Google Cloud Console に移動します。
2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
3. 左側のナビゲーションメニューで、認証情報を選択します。
4. 認証情報を作成 -> サービスアカウントを選択します。
5. サービスアカウントの作成ページで、サービスアカウント名、サービスアカウントID、 および任意でサービスアカウントの説明を入力します。
6. 完了をクリックします。Cloud コンソールは認証情報ページを再表示します。
7. サービスアカウントセクションで、作成したサービスアカウントを選択します。
8. キータブをクリックします。
9. 鍵を追加 -> 新しい鍵を作成 をクリックします。
10. サポートされているキータイプ（OAuthJWTCert およびOAuthJWTCertType を参照）を選択します。
11. 作成をクリックします。キーは自動的にデバイスにダウンロードされ、キーに固有の追加情報が表示されます。
12. 後で使用するために、追加情報を記録しておきます。

サービスアカウントフローを完了させるには、Google Cloud Console で秘密キーを生成します。サービスアカウントフローにおいて、ドライバーはOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。ドライバーには、サービスアカウントに付与されているのと同じ権限が与えられます。

Google Drive への認証

Sync App は、認証にユーザーアカウントおよびGCP インスタンスアカウントの使用をサポートします。

以下のセクションでは、Google Drive の利用可能な認証スキームについて説明します。

• ユーザーアカウント（OAuth）
• サービスアカウント（OAuthJWT）
• GCP インスタンスアカウント

ユーザーアカウント（OAuth）

AuthScheme は、すべてのユーザーアカウントフローでOAuth に設定する必要があります。

GCP インスタンスアカウント

GCP 仮想マシン上で実行している場合は、Sync App は仮想マシンに関連付けられたサービスアカウントを使用して認証できます。 このモードを使用するには、AuthScheme をGCPInstanceAccount に設定します。

カスタムOAuth アプリケーションの作成

（OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「CSV への接続」の デスクトップ認証セクションを参照してください。）

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成（独自のOAuth アプリケーションクレデンシャルを使用）することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

以下のセクションでは、Directory API を有効化し、ユーザーアカウント（OAuth）およびサービスアカウント（OAuth / JWT）用のカスタムOAuth アプリケーションを作成する方法について説明します。

Google Drive API を有効化

1. Google Cloud Console に移動します。
2. 左側のナビゲーションメニューからライブラリを選択します。API ライブラリページが開きます。
3. 検索ボックスに、"Google Drive API" と入力し、検索結果からGoogle Drive API を選択します。
4. Google Drive API ページで、有効にするをクリックします。

OAuth アプリケーションの作成

ユーザーアカウント（OAuth）

AuthScheme がOAuth であり、Web アプリケーション上で認証する必要があるユーザーの場合は、必ずカスタムOAuth アプリケーションを作成する必要があります。 （デスクトップおよびヘッドレスフローでのカスタムOAuth アプリケーションの作成は任意です。）

以下の手順に従います。

1. Google Cloud Console に移動します。
2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
3. 左側のナビゲーションメニューで、認証情報を選択します。
4. このプロジェクトに同意画面がまだ設定されていない場合は、同意画面を設定 をクリックして作成します。Google Workspace アカウントを使用しない場合、User Type が外部の同意画面の作成に制限され、ユーザーサポートメールとデベロッパーの連絡先情報を指定する必要があります。 追加情報は任意です。
5. 認証情報ページで認証情報を作成 -> OAuth クライアントID を選択します。
6. アプリケーションの種類メニューでウェブアプリケーションを選択します。
7. カスタムOAuth アプリケーションの名前を指定します。
8. 承認済みのリダイレクトURI の下にあるURI を追加をクリックし、リダイレクトURI を入力します。
9. Enter をクリックし、続けて作成をクリックします。Cloud コンソールは認証情報ページに戻ります。
   ウィンドウが開き、クライアントId とクライアントシークレットが表示されます。
10. 後でOAuthClientId とOAuthClientSecret として使用するために、クライアントId とクライアントシークレットを記録しておきます。

Note： クライアントシークレットはGoogle Cloud コンソールからアクセス可能です。

サービスアカウント（OAuthJWT）

新しいサービスアカウントを作成するには：

1. Google Cloud Console に移動します。
2. 新しいプロジェクトを作成するか、既存のプロジェクトを選択します。
3. 左側のナビゲーションメニューで、認証情報を選択します。
4. 認証情報を作成 -> サービスアカウントを選択します。
5. サービスアカウントの作成ページで、サービスアカウント名、サービスアカウントID、 および任意でサービスアカウントの説明を入力します。
6. 完了をクリックします。Cloud コンソールは認証情報ページを再表示します。
7. サービスアカウントセクションで、作成したサービスアカウントを選択します。
8. キータブをクリックします。
9. 鍵を追加 -> 新しい鍵を作成 をクリックします。
10. サポートされているキータイプ（OAuthJWTCert およびOAuthJWTCertType を参照）を選択します。
11. 作成をクリックします。キーは自動的にデバイスにダウンロードされ、キーに固有の追加情報が表示されます。
12. 後で使用するために、追加情報を記録しておきます。

サービスアカウントフローを完了させるには、Google Cloud Console で秘密キーを生成します。サービスアカウントフローにおいて、ドライバーはOAuthAccessToken へのJSON Web Token (JWT) を交換します。秘密キーはJWT の署名に必要です。ドライバーには、サービスアカウントに付与されているのと同じ権限が与えられます。

HTTP(S) への認証

Sync App は、HTTP(S) ストリームに格納されたCSV データへの接続を汎用的にサポートします。

ユーザー / パスワード、Digest アクセス、OAuth、OAuthJWT、OAuth PASSWORD フローなど、複数の認証方式に対応しています。

また、認証設定のないストリームに接続することも可能です。

認証なし

認証なしでHTTP（S）ストリームに接続するには、AuthScheme 接続プロパティをNone に設定します。

Basic

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

• AuthScheme：Basic に設定。
• User：HTTP(S) ストリームに紐づいているユーザー名に設定。
• Password：HTTP(S) ストリームに紐づいているパスワードに設定。

Digest

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

• AuthScheme：Digest に設定。
• User：HTTP(S) ストリームに紐づいているユーザー名に設定。
• Password：HTTP(S) ストリームに紐づいているパスワードに設定。

OAuth

OAuth では認証するユーザーにブラウザでCSV との通信を要求します。次のセクションで説明するとおり、Sync App はさまざまな方法でこれをサポートします。

次の手順を実行する前に、操作したいCSV データを持つサービスにOAuth アプリを登録する必要があります。

ほとんどのサービスではカスタムアプリケーションを作成する場合、開発者登録をしてサービスのUI でアプリを作成する必要があります。

ただし、すべてのサービスに当てはまるわけではありません。アプリの作成をサービスプロバイダーに依頼しなければならない場合もあります。どんな場合でも、OAuthClientId、OAuthClientSecret、およびCallbackURL の値を取得する必要があります。

OAuth JWT

AuthScheme をOAuthJWT に設定します。

Sync App は、ユーザーが双方向のサインオンを実行できない状況で、認可グラントとしてのJWT の使用をサポートします。 次の接続プロパティを設定して、接続してください。

• OAuthVersion：2.0 に設定。
• OAuthAccessTokenURL：JWT がアクセストークンと交換されるURL に設定します。
• OAuthJWTCert：使用する証明書に設定します。多くの場合、これはPEM またはPFX ファイルへのパスです。
• OAuthJWTCertType：正しい証明書タイプに設定します。多くの場合、PEMKEY_FILE またはPFXFILE のいずれかです。
• OAuthJWTCertPassword：証明書が暗号化されている場合、これを暗号化パスワードに設定します。
• OAuthJWTIssuer：発行元に設定します。これはJWT のiss フィールドに相当します。

JWT 署名のアルゴリズムを直接設定できないことに注意してください。Sync App は、RS256 アルゴリズムにのみ対応しています。

Sync App は以下のフィールドを含むJWT を構築してOAuthAccessTokenURL にアクセストークンを送信します。

• scope 提供されている場合、Scope から取得されます。
• aud 提供されている場合、OAuthJWTAudience から取得されます。
• iss OAuthJWTIssuer から取得されます。
• iat これはJWT が生成された時間です。
• exp これは、iat の値にOAuthJWTValidityTime の値を加えたものです。
• sub 提供されている場合、OAuthJWTSubject から取得されます。

OAuthPassword

AuthScheme：OAuthPassword に設定。

OAuth では認証するユーザーにブラウザでCSV との通信を要求します。次のセクションで説明するとおり、Sync App はさまざまな方法でこれをサポートします。

次の手順を実行する前に、操作したいCSV データを持つサービスにOAuth アプリを登録する必要があります。

ほとんどのサービスではカスタムアプリケーションを作成する場合、開発者登録をしてサービスのUI でアプリを作成する必要があります。

ただし、すべてのサービスに当てはまるわけではありません。アプリの作成をサービスプロバイダーに依頼しなければならない場合もあります。どんな場合でも、OAuthClientId、OAuthClientSecret、およびCallbackURL の値を取得する必要があります。

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

• OAuthVersion：OAuth バージョン1.0 か2.0 のいずれかに設定します。
• 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 を指定した場合には、一致している必要があります。

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

接続の前に

Cloud Object Storage の新規インスタンスの登録

IBM Cloud アカウントにCloud Object Storage がまだない場合は、以下の手順に従ってアカウントにSQL Query のインスタンスをインストールできます。

1. IBM Cloud アカウントにログインします。
2. Cloud Object Storage ページに移動し、インスタンス名を指定して作成をクリックします。作成したばかりのCloud Object Storage のインスタンスにリダイレクトされます。

API キー

IBM Cloud Object Storage に接続するにはApiKey が必要です。これは次のようにして取得できます。

1. IBM Cloud アカウントにログインします。
2. Platform API Keys ページに移動します。
3. 中央右隅のCreate an IBM Cloud API Key をクリックして、新しいAPI キーを作成します。
4. ポップアップウィンドウが表示されたら、API キー名を指定して作成をクリックします。ダッシュボードからは再びアクセスできなくなるため、ApiKey を控えておきます。

IBM Cloud Object Storage への接続

Region をIBM インスタンスリージョンに設定します。

IBM Cloud Object Storage への認証

HMAC またはOAuth のいずれかを使用して、IBM Cloud Object Storage への認証ができます。

HMAC

次のプロパティを設定して認証します。

• AccessKey：IBM アクセスキー（ユーザー名）に設定。
• SecretKey：IBM シークレットキーに設定。

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; AccessKey=token1; SecretKey=secret1; Region=eu-gb;

OAuth

OAuth 認証を使用して認証するには以下を設定します。

• AuthScheme：OAuth に設定。
• ApiKey：セットアップ中にメモしたIBM API キーに設定。

ConnectionType=IBM Object Storage Source;URI=ibmobjectstorage://bucket1/folder1; ApiKey=key1; Region=eu-gb; AuthScheme=OAuth; InitiateOAuth=GETANDREFRESH;

接続すると、Sync App がOAuth プロセスを完了します。

OneDrive への接続

OneDrive への認証には、Azure AD ユーザー、MSI 認証、Azure サービスプリンシパルを使用できます。

AzureAD ユーザー

AuthScheme は、すべてのユーザーアカウントフローでAzureAD に設定する必要があります。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

クライアントシークレット

次の接続プロパティを設定します。

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

次の接続プロパティを設定します。

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Azure MSI

Azure Data Lake Storage のアクセス許可を持つAzure VM で接続する場合は、以下AuthScheme をAzureMSI に設定します。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。認証するには以下のように設定します。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

カスタムAzureAD アプリケーションには、AzureAD とAzure サービスプリンシパルを使用するAzureAD の2種類があります。いずれもOAuth ベースです。

カスタムアプリケーションを作成するタイミング

以下の場合はユーザー自身のAzureAD アプリケーションクレデンシャルを選択できます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムAzureAD アプリケーション

カスタムAzureAD アプリの作成

下記の手順に従って、アプリケーションのAzureAD 値OAuthClientId およびOAuthClientSecret を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリケーション名を入力し、目的のテナント設定を選択します。 Azure Active Directory でカスタムAzureAD アプリケーションを作成する場合、アプリケーションをシングルテナントまたはマルチテナントに定義できます。デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Sync App への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。アプリケーションが個人使用のみの場合は、［この組織ディレクトリ内のアカウントのみ］で十分です。アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。
5. リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。あるいは、任意の別のポートを指定して、CallbackURL を定義した正確なリプライURL に設定します。
6. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が自動的に開きます。OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
7. ［証明書とシークレット］セクションに移動して、アプリケーションの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書を使用する方法です。
   • オプション1：証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2：新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。 これは、OAuthClientSecret として必要になります。
8. API のアクセス許可 -> アクセス許可の追加をクリックします。ユーザーコンテキストなしでアプリを接続する予定の場合は、アプリケーションの許可（OAuthGrantType = CLIENT）を選択します。それ以外の場合は、委任されたアクセス許可を使用します。
9. 変更を保存します。
10. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを選択した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパルカスタムアプリケーション

Azure サービスプリンシパルを使用して認証する場合は、カスタムAzureAD アプリケーションと必要なリソースにアクセスできるサービスプリンシパル両方の作成が必要です。次の手順に従って、カスタムAzureAD アプリケーションを作成し、Azure サービスプリンシパル認証用の接続プロパティを取得します。

Azure サービスプリンシパルでカスタムAzureAD アプリを作成

下記の手順に従って、アプリケーションのAzureAD 値を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリ名を入力し、［任意のAzure AD ディレクトリ - マルチテナント］を選択します。そして、リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。
5. アプリ作成後に、［概要］セクションに表示されているアプリケーション（クライアント）Id の値をコピーします。この値はOAuthClientId として使用されます。
6. ［証明書とシークレット］セクションに移動して、アプリの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書による方法です。
   • オプション1 - 証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2 - 新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。これは、OAuthClientSecret として使用します。
7. 認証タブで、必ずアクセストークン（暗黙的なフローに使用）を選択してください。

OneLake への認証

OneLake への認証には、Azure AD ユーザー、Azure MSI、またはAzure サービスプリンシパルを使用できます。

AzureAD ユーザー

AuthScheme は、すべてのユーザーアカウントフローでAzureAD に設定する必要があります。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

クライアントシークレット

次の接続プロパティを設定します。

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

次の接続プロパティを設定します。

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

Azure MSI

Azure Data Lake Storage のアクセス許可を持つAzure VM で接続する場合は、AuthScheme をAzureMSI に設定します。

Azure サービスプリンシパル

クライアントシークレットではなくサービスプリンシパルで認証したい場合は、クライアント証明書で認証できます。認証するには以下のように設定します。

• AuthScheme：AzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthGrantType：CLIENT に設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

カスタムAzureAD アプリケーションには、AzureAD とAzure サービスプリンシパルを使用するAzureAD の2種類があります。いずれもOAuth ベースです。

カスタムアプリケーションを作成するタイミング

以下の場合、独自のAzureAD アプリケーション認証情報を使用することもできます。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

カスタムAzureAD アプリケーション

カスタムAzureAD アプリの作成

下記の手順に従って、アプリケーションのAzureAD 値OAuthClientId およびOAuthClientSecret を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリケーション名を入力し、目的のテナント設定を選択します。 Azure Active Directory でカスタムAzureAD アプリケーションを作成する場合、アプリケーションをシングルテナントまたはマルチテナントに定義できます。デフォルトのオプション［この組織ディレクトリ内のアカウントのみ］を選択する場合は、CData Sync App への接続を確立するときにAzureTenant 接続プロパティをAzure AD テナントのId に設定する必要があります。それ以外の場合は、認証に失敗しエラーが発生します。アプリケーションが個人使用のみの場合は、［この組織ディレクトリ内のアカウントのみ］で十分です。アプリケーションを配布する場合は、マルチテナントオプションのいずれか1つを選択してください。
5. リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。あるいは、任意の別のポートを指定して、CallbackURL を定義した正確なリプライURL に設定します。
6. 登録をクリックして新しいアプリケーションを登録します。アプリケーション管理画面が自動的に開きます。OAuthClientId としてApplication (client) ID の値、AzureTenant としてDirectory (tenant) ID の値をメモします。
7. ［証明書とシークレット］セクションに移動して、アプリケーションの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書を使用する方法です。
   • オプション1：証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2：新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。 これは、OAuthClientSecret として必要になります。
8. API のアクセス許可 -> アクセス許可の追加 -> Azure Storage -> user_impersonation -> アクセス許可の追加を選択します。
9. 変更を保存します。
10. 管理者の同意が必要なアクセス許可（［アプリケーションの許可］など）を使用することを選択した場合は、API のアクセス許可ページで現在のテナントから付与することができます。

Azure サービスプリンシパルカスタムアプリケーション

Azure サービスプリンシパルを使用して認証する場合は、カスタムAzureAD アプリケーションと必要なリソースにアクセスできるサービスプリンシパル両方の作成が必要です。次の手順に従って、カスタムAzureAD アプリケーションを作成し、Azure サービスプリンシパル認証用の接続プロパティを取得します。

Azure サービスプリンシパルでカスタムAzureAD アプリを作成

下記の手順に従って、アプリケーションのAzureAD 値を取得します。

1. https://portal.azure.com にログインします。
2. 左側のナビゲーションペインですべてのサービスを選択します。アプリの登録を検索して選択します。
3. 新規登録をクリックします。
4. アプリ名を入力し、任意のAzure AD ディレクトリ - マルチテナントを選択します。そして、リダイレクトURL をSync App のデフォルトhttp://localhost:33333 に設定します。
5. アプリ作成後に、［概要］セクションに表示されているアプリケーション（クライアント）Id の値をコピーします。この値はOAuthClientId として使用されます。
6. ［証明書とシークレット］セクションに移動して、アプリの認証タイプを定義します。認証には、クライアントシークレットを使用する方法と、証明書を使用する方法の2種類があります。推奨されている認証方法は証明書による方法です。
   • オプション1 - 証明書をアップロードする：［証明書とシークレット］で証明書のアップロードを選択し、ローカルマシンからアップロードする証明書を選択します。
   • オプション2 - 新しいアプリケーションシークレットを作成する：［証明書とシークレット］で新しいクライアントシークレットを選択し、有効期限を指定します。クライアントシークレットを保存すると、キーの値が表示されます。 表示は一度のみなのでこの値をコピーします。これは、OAuthClientSecret として使用します。
7. 認証タブで、必ずアクセストークン（暗黙的なフローに使用）を選択してください。

ワークスペースへのサービスプリンシパルの追加

以下の手順に従って、ワークスペースにサービスプリンシパルを追加します。

1. Microsoft Fabric にログインします。
2. 右上の歯車アイコン（設定）をクリックします。
3. 管理ポータルを選択します。
4. 左側のナビゲーションペインでテナント設定を選択します。
5. スクロールして開発者向け設定を見つけます。
6. サービスプリンシパルはFabric API を使用できますを展開します。
7. オプションを有効化します。
8. 適用を選択します。
9. サービスプリンシパルを追加するワークスペースを選択します。
10. アクセスの管理をクリックします。
11. ユーザーまたはグループの追加をクリックします。
12. アプリケーションの名前を入力します（同じ名前のアプリケーションが複数ある場合は、ID を確認します）。
13. アプリケーションに許可するアクセスレベルを設定します。 共同作成者は、API 経由でOneLake にアクセスするために必要となる最低セキュリティレベルです。
14. 追加を選択します。

SFTP への接続

SFTP に認証するには、ユーザーとパスワード、またはSSH 証明書を使用します。さらに、認証なしでの接続が有効なSFTP サーバーに接続することもできます。

認証なし

サーバーが認証なしでの接続に対応している場合、接続するには、SSHAuthMode をNone に設定します。

パスワード

SFTP サーバーに紐づいているユーザー資格情報を入力します。

• SSHAuthMode：Password に設定。
• SSHUser：SFTP サーバーに紐づいているユーザー名。
• SSHPassword：ユーザーに紐付けられたパスワード。

SSH 証明書

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

• SSHAuthMode：Public_Key に設定。
• SSHClientCert：SSH 証明書をSSHClientCertType で指定した形式で指定（この接続プロパティの関連ドキュメントを参照してください）。
• SSHClientCertType：SSHClientCert で指定されたキーストアの種類。
• SSHClientCertPassword（オプション）：証明書ストアパスワード。
• SSHClientCertSubject（オプション）：キーストアに複数のキーがある場合、ここで目的のキーを名前で指定します。

SharePoint Online への接続（REST）

REST API では、以下の認証スキームがサポートされています。

• AzureAD
• MSI
• AzureServicePrincipal

AzureAD

Azure テナントの新しいAzureAD アプリケーションを承認する際、組織による管理者の同意が必要になる場合があります。すべてのAzureAD フローにおいて、AzureAD アプリケーションの初期インストールと使用の際は、管理者がそのAzure テナントのアプリケーションを承認する必要があります。

Azure サービスプリンシパル

Azure サービスプリンシパルとしての認証は、OAuth クライアントクレデンシャルフローを介して処理されます。直接のユーザー認証は行われません。代わりに、クレデンシャルはアプリケーション自体のためだけに作成されます。アプリで実行されるすべてのタスクは、デフォルトユーザーコンテキストなしで実行されます。リソースへのアプリケーションのアクセスは、割り当てられたロールの権限によって制御されます。

AzureAD アプリとAzure サービスプリンシパルの作成

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにAzure AD アプリケーションを作成して登録する必要があります。詳しくは、Azure AD アプリケーションの作成 を参照してください。

portal.azure.com の［アプリの登録］で［API のアクセス許可］に移動し、Microsoft Graph アクセス許可を選択します。アクセス許可には2つの異なるアクセス許可セットがあります。委任されたアクセス許可とアプリケーションの許可です。クライアントの資格情報認証時に使用されるアクセス許可は、［アプリケーションの許可］の下にあります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、サブスクリプションページを開きます。
2. アプリケーションを割り当てるサブスクリプションを選択します。
3. アクセス制御 (IAM)を開き、追加 -> ロール割り当ての追加 を選択してロール割り当ての追加ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、所有者を選択します。

クライアントシークレット

次の接続プロパティを設定します。

• AuthScheme：クライアントシークレットを使用する場合はAzureServicePrincipal。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth の交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthClientId：アプリケーション設定のクライアントId。
• OAuthClientSecret：アプリケーション設定のクライアントシークレット。

証明書

次の接続プロパティを設定します。

• AuthScheme：証明書を使用する場合はAzureServicePrincipalCert。
• InitiateOAuth： GETANDREFRESH。InitiateOAuth を使えば、繰り返しOAuth 交換を行ったり、手動でOAuthAccessToken を設定する必要はなくなります。
• AzureTenant：接続するテナント。
• OAuthJWTCert：JWT 証明書のストア。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類。

これで接続する準備が整いました。クライアント資格情報での認証は、他の接続同様に自動的に行われますが、ユーザーにプロンプトするウィンドウは表示されません。ユーザーコンテキストがないため、ブラウザのポップアップは必要ないからです。接続が行われ、内部的に処理されます。

MSI

Azure VM 上でCSV を実行している場合は、Managed Service Identity（MSI）の資格情報を利用して接続が可能です。

• AuthScheme：AzureMSI に設定。

MSI 資格情報が認証用に自動的に取得されます。

Azure サービスプリンシパル

Azure サービスプリンシパルを使用して認証する場合、Azure AD テナントにアプリケーションを登録する必要があります。

アプリケーションへのロールの割り当て

サブスクリプションのリソースにアクセスするには、アプリケーションにロールを割り当てる必要があります。

1. 検索バーでサブスクリプションサービスを検索・選択して、［サブスクリプション］ページを開きます。
2. アプリケーションを割り当てる特定のサブスクリプションを選択します。
3. ［アクセス制御 (IAM)］を開き、［追加］->［ロール割り当ての追加］を選択して［ロール割り当ての追加］ページを開きます。
4. 作成したAzure AD アプリに割り当てるロールとして、［所有者］を選択します。

Azure サービスプリンシパルを使用した認証

設定されたアプリ認証（クライアントシークレットまたは証明書）に応じて、以下のいずれかの接続プロパティグループを設定すると、接続できるようになります。

クライアントシークレットまたは証明書認証を選択する前に、以下を設定します。

• AuthScheme：アプリ設定のAzureServicePrincipal に設定。
• AzureTenant：接続するテナントに設定。
• OAuthClientId：アプリ設定のクライアントId に設定。
• OAuthGrantType：CLIENT に設定。

オプション1：クライアントシークレットを使用した認証

クライアントシークレットで認証するには、以下のように設定します。

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

オプション2：JWT 証明書を使用した認証

JWT 証明書で認証するには、以下のように設定します。

• OAuthJWTCert：JWT 証明書ストアに設定。
• OAuthJWTCertType：OAuthJWTCert で指定された証明書ストアの種類に設定。

SharePoint Online への接続（SOAP）

SOAP API では、以下の認証がサポートされています。

• ユーザー資格情報
• ADFS
• Okta
• OneLogin

ユーザー資格情報

ADFS

AuthScheme をADFS に設定します。次の接続プロパティを設定する必要があります。

• User：ADFS ユーザーに設定。
• Password：ユーザーのADFS パスワードに設定。
• SSOLoginURL：ADFS サーバーのベースURL に設定。

AuthScheme=ADFS;User=ADFSUserName;Password=ADFSPassword;URL='http://sharepointserver/mysite';

Okta

AuthScheme をOkta に設定します。Okta に接続するには、次の接続プロパティを使用します。

• User：Okta ユーザーに設定。
• Password：ユーザーのOkta パスワードに設定。
• SSOLoginURL：Okta アプリケーションの埋め込みリンクに設定。

次は接続文字列の例です。

AuthScheme=Okta;User=oktaUserName;Password=oktaPassword;URL='http://sharepointserver/mysite';

OneLogin

AuthScheme をOneLogin に設定します。OneLogin への接続には、次の接続プロパティを使用します。

• User：OneLogin ユーザーに設定。
• Password：ユーザーのOneLogin パスワードに設定。

次は接続文字列の例です。

AuthScheme=OneLogin;User=OneLoginUserName;Password=OneLoginPassword;URL='http://sharepointserver/mysite';

SSO 認証

AzureAD

Azure AD の設定

この構成の背景にあるメインテーマはOAuth 2.0 On-Behalf-Of flow です。 これにはAzure AD アプリケーションが2つ必要です。

1. 特定のサービスプロバイダーへのシングルサインオンプロセスに使用されるアプリケーション。
   • Amazon S3： このアプリケーションを作成する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Azure AD からAWS コンソールにログイン可能であることを確認してください。

     "Azure AD テストユーザーの割り当て" の手順は、ユーザーを割り当てる際にAWS ロールを選択できるように、プロビジョニング後まで保存しておきます。

2. 前の手順で作成したSSO アプリケーションに対するuser_impersonation 権限を持つ「コネクタ」プリケーション。 ［Azure Active Directory］->［アプリの登録］に進み、新しいアプリケーションを登録します。アプリケーションを登録したら、SSO アプリケーションへのAPI 呼び出しを許可する必要があります。 登録したアプリのAPI のアクセス許可セクションに移動して、［アクセス許可の追加］ボタンをクリックします。API 名またはアプリケーションId を指定してSSO アプリケーションのAPI を選択し、 user_impersonation アクセス許可を追加します。

CData ドライバーの共通プロパティ

次のSSOProperties がAzure Active Directory への認証に必要です。すべてのサービスプロバイダーに指定する必要があります。

• Resource：アプリ登録の概要セクションにリストされている、SSO アプリケーションのアプリケーションId URI。
• Tenant：アプリケーションが登録されているAzure AD テナントのId。この値はhere で確認できます。

OAuth 2.0 On-Behalf-Of フローからSSO SAML レスポンスを取得するので、次のOAuth 接続プロパティを指定する必要があります。

• OAuthClientId：アプリ登録の概要セクションにリストされている、コネクタアプリケーションのアプリケーションId。
• OAuthClientSecret：コネクタアプリケーションのクライアントシークレット値。新しいクライアントシークレットを作成すると、Azure AD にこれが表示されます（証明書 & シークレットのセクション）。

Amazon S3

Amazon S3 サービスプロバイダーに接続するときは、共通プロパティに加えて、次のプロパティを指定する必要があります。

• AuthScheme：AuthScheme をAzureAD に設定します。
• AWSRoleARN：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。

AuthScheme=AzureAD;InitiateOAuth=GETANDREFRESH;OAuthClientId=d593a1d-ad89-4457-872d-8d7443aaa655;OauthClientSecret=g9-oy5D_rl9YEKfN-45~3Wm8FgVa2F;SSOProperties='Tenant=94be7-edb4-4fda-ab12-95bfc22b232f;Resource=https://signin.aws.amazon.com/saml;';AWSRoleARN=arn:aws:iam::2153385180:role/AWS_AzureAD;AWSPrincipalARN=arn:aws:iam::215515180:saml-provider/AzureAD;

OneLogin

OneLogin の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： このアプリケーションを作成する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、OneLogin からOffice 365 にログイン可能であることを確認してください。 アプリケーション内でWS-Trust を有効化してください。有効化されていない場合、CData ドライバーは接続できません。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOneLogin に設定。
• User：OneLogin アカウントのユーザー名。
• Password：OneLogin アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='OneLogin';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Okta

Okta の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： このアプリケーションを作成してSSO を設定する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Okta からOffice 365 にログイン可能であることを確認してください。 アプリケーション内でWS-Federation を使用してSSO を設定してください。設定されていない場合、CData ドライバーは接続できません。
• Amazon S3： このアプリケーションを作成してSSO を設定する方法については、こちらのlink詳しい手順を参照してください。接続をテストして、Okta からAWS にログイン可能であることを確認してください。 アプリケーション内でSAML 2.0でSSO を設定してください。設定されていない場合、CData ドライバーは接続できません。 Okta アプリで割り当てられたAWS ロールが、接続するS3バケットにアクセスできることを確認します。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOkta に設定。
• User：Okta アカウントのユーザー名。
• Password：Okta アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='Okta';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Amazon S3

以下のプロパティは、Amazon S3サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をOkta に設定。
• User：Okta アカウントのユーザー名。
• Password：Okta アカウントのパスワード。
• SSOLoginURL：AWS Okta SSO アプリの埋め込みURL に設定。
• AWSRoleARN（オプション）：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN（オプション）：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。
• SSOProperties：
  • APIToken（オプション）：顧客がOkta 組織で作成したAPI Token に設定。Okta クライアントリクエストコンテキストをオーバーライドする、信頼されたアプリケーションまたはプロキシ経由でユーザーを認証する場合に使用してください。

AuthScheme=Okta;User=OktaUser;Password=OktaPassword;SSOLoginURL='https://{subdomain}.okta.com/home/amazon_aws/0oan2hZLgQiy5d6/272';

ADFS

ADFS の設定

特定のプロバイダーへのシングルサインオン処理に使用するアプリケーションを、作成する必要があります。

• SharePoint SOAP： Office 365 のシングルサインオン用にADFS を設定するには、こちらのlink詳しい手順を参照してください。接続をテストして、ADFS からOffice 365 にログイン可能であることを確認してください。
• Amazon S3： AWS のシングルサインオン用にADFS を設定するには、こちらのlink詳しい手順を参照してください。接続をテストして、ADFS からAWS にログイン可能であることを確認してください。

SharePoint SOAP

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をADFS に設定。
• User：ADFS アカウントのユーザー名。
• Password：ADFS アカウントのパスワード。
• SSOProperties：
  • Domain（オプション）：SSO のドメインで設定されたドメインがUser のドメインと異なる場合には、このプロパティを設定する必要がある場合があります。

AuthScheme='ADFS';User=test;Password=test;SSOProperties='Domain=test.cdata;';

Amazon S3

以下のプロパティは、SharePoint SOAP サービスプロバイダーに接続する際には指定する必要があります。

• AuthScheme：AuthScheme をADFS に設定。
• SSOLoginURL：ADFS インスタンスのURL に設定。
• User：ADFS アカウントのユーザー名。
• Password：ADFS アカウントのパスワード。
• AWSRoleARN（オプション）：IAM ロールのARN。IAM ロールの概要ページに示されています。
• AWSPrincipalARN（オプション）：ID プロバイダーのARN。ID プロバイダーの概要ページに示されています。

AuthScheme=ADFS;User=username;Password=password;SSOLoginURL='https://sts.company.com';

ADFS 統合フローでは、現在ログインしているWindows ユーザーの資格情報で接続します。 ADFS 統合フローを使用するには、User およびPassword を指定せず、それ以外の設定は上記のADFS ガイドと同じステップを実行してください。

Kerberos

Kerberos でCSV への認証を行うには、AuthScheme をNEGOTIATE に設定します。

Kerberos 経由でCSV への認証を行うには、認証プロパティを定義し、Kerberos が認証チケットを取得する方法を選択する必要があります。

Kerberos チケットの取得

Sync App は、 KRB5CCNAME および / またはKerberosKeytabFile 変数が存在するかどうかに応じて、必要なKerberos チケットを取得する3 つの方法を提供します。

MIT Kerberos 資格情報キャッシュファイル

このオプションを使用すると、MIT Kerberos チケットマネージャーまたはkinit コマンドを使ってチケットを取得できます。このオプションでは、User またはPassword 接続プロパティを設定する必要はありません。

このオプションは、KRB5CCNAME がシステムに作成されている必要があります。

MIT Kerberos 資格情報キャッシュファイル経由でチケット検索を有効にするには：

1. お使いの環境にKRB5CCNAME 変数が存在することを確認します。
2. KRB5CCNAME を資格情報キャッシュファイルを指すパスに設定します。（例えば、C:\krb_cache\krb5cc_0 または/tmp/krb5cc_0 です。）資格情報キャッシュファイルは、MIT Kerberos チケットマネージャーを使用してチケットを生成するときに作成されます。
3. チケットを取得するには：
   1. MIT Kerberos チケットマネージャーアプリケーションを開きます。
   2. Get Ticket をクリックします。
   3. プリンシパル名とパスワードを入力します。
   4. OK をクリックします。

   チケットの取得に成功すると、チケット情報がKerberos チケットマネージャーに表示され、クレデンシャルキャッシュファイルに保存されます。

Sync App はキャッシュファイルを使用してCSV に接続するためのKerberos チケットを取得します。

Note： KRB5CCNAME を編集したくない場合は、KerberosTicketCache プロパティを使用してファイルパスを手動で設定することができます。この設定後に、Sync App は指定されたキャッシュファイルを使用してCSV に接続するためのKerberos チケットを取得します。

Keytab ファイル

お使いの環境にKRB5CCNAME 環境変数がない場合、Keytab ファイルを使用してKerberos チケットを取得できます。

この方法を使用するには、User プロパティを目的のユーザー名に設定し、KerberosKeytabFile プロパティをユーザーに関連付けられたキータブファイルを指すファイルパスに設定します。

User およびPassword

お使いの環境にKRB5CCNAME 環境変数およびKerberosKeytabFile プロパティが設定されていない場合、ユーザーとパスワードの組み合わせを使用してチケットを取得できます。

この方法を使用するには、User およびPassword プロパティを、CSV での認証に使用するユーザー / パスワードの組み合わせに設定します。

クロスレルム認証の有効化

このようなクロスレルム認証を有効にするには、KerberosRealm およびKerberosKDC プロパティをユーザー認証に必要な値に設定します。また、KerberosServiceRealm およびKerberosServiceKDC プロパティを、 サービスチケットの取得に必要な値に設定します。

リソースの場所

• 値が空の場合は、URL を自動的にカレントディレクトリ"./" への参照に割り当てます。CSV フォルダへの明示的なパスは、実行中のアプリケーションの環境に依存します。
• フォルダへのパス。
• .zip、.tar、または.gz アーカイブファイルへのパス。
  • ファイルを含むディレクトリだけでなく、そのファイルも含めます。例： C:\Users\Public\Documents\CSVdata.zip
• ファイルまたはストリームへのパス - この場合、SELECT * FROM streamedtable を実行してファイルをクエリできます。

テーブルのモデル化

次のプロパティを設定して、Sync App がCSV をテーブルとしてモデル化する方法を制御します。

• IncludeColumnHeaders：指定したファイルの一行目からカラム名を取得するように設定します（デフォルト）。そうでない場合は、カラム名はカラム番号になります。
• FMT：テキストファイルのパースに使用する形式に設定します。CsvDelimited（デフォルト）またはTabDelimited。
• IncludeFiles：テーブルとしてモデル化されるファイル一式に含める、ファイル拡張子のカンマ区切りリストに設定します。（デフォルトでは.txt、.tab、および.csv ファイルがモデル化されます。）
  • ファイルの拡張子を、'.' を除いて大文字で指定します。例："CSV,TXT,TAB"
  • アーカイブファイルはサポートされており（ZIP、TAR、およびGZ）、フォルダのようにモデル化されます。
• RowScanDepth：指定した深さまで行をスキャンして、データ型を自動的に決定するように設定します。

CData Sync App は、ワイヤプロトコルを介した接続からテーブルをモデル化するまでの、ローカルおよびリモートのCSV データの処理の複雑さを隠します。ただし、これらのレイヤーを制御することもできます。

自動スキーマ検出のカスタマイズ

Sync App は、指定された接続プロパティに基づいてCSV からスキーマを動的に派生します。利用可能な接続プロパティを使用すると、データがテーブルとしてモデル化される方法のさまざまな側面を制御できます。接続の設定について詳しくは、CSV データソースへの接続 を参照してください。ローカルCSV で作業する場合は、Microsoft Jet ドライバーで使用される構成であるSchema.ini を使用して、カラム定義とファイル形式を設定することもできます。

レポートされたカラムや、データをテーブルとしてモデル化するその他の側面をより細かく制御するために、独自のスキーマを定義するか生成されたスキーマを拡張することができます。スキーマは、拡張可能なコンフィギュレーションファイルで定義されます。検出されたスキーマを設定ファイルに保存するには、スキーマファイルの生成 を参照してください。このファイルは簡単に編集できます。

次のセクションでは、スキーマをカスタマイズする方法やゼロから記述する方法について説明します。

カスタムスキーマのオーサリング

テーブルとビューは、API Script でスキーマファイルを作成することによって定義されます。API Script は、テーブルのカラムとその動作を定義するシンプルなAPI Script コンフィギュレーション言語にて書かれています。また、CSV を処理可能にするビルトインオペレーションがあります。

これらのデータ処理構造に加えて、API Script は、条件分岐やループなどに対応して構成されているフル機能の言語です。ただし、サンプルスキーマに示すように、ほとんどのテーブル定義ではこれらの機能を使用する必要はありません。

以下は、一般的なNorthwind サンプルデータベースのPerson エンティティをモデル化した、完全な機能を持つテーブルスキーマです。これには、SQL を通じでデータソースにアクセスするために必要なすべてのコンポーネントが含まれています。これらのコンポーネントの詳細は、カラムの定義 およびSELECT 実行 を参照してください。

<api:script>
  <!-- See Column Definitions to define column behavior. -->
   <api:info title="CSVPersons" desc="Parse the CSV Persons feed.">
    <attr name="ID"           xs:type="int" key="true"  />
    <attr name="EmployeeID"   xs:type="int"             />
    <attr name="Name"         xs:type="string"          />
    <attr name="TotalExpense" xs:type="double"          />
    <attr name="HireDate"     xs:type="datetime"        />
    <attr name="Salary"       xs:type="int"             />
  </api:info>

  <api:set attr="uri" value="http://pathtocsvstream" /> 
  
  <!-- The GET method corresponds to SELECT. The results of processing are pushed to the schema's output. See SELECT Execution for more information. -->
  <api:script method="GET" >
    <api:call  op="csvproviderGet"/>
  </api:script>

  <!-- Not implemented -->
  <api:script method="POST">
    <api:call op="csvproviderInsert">
      <api:push/>
    </api:call>
  </api:script>

  <!-- Not implemented -->
  <api:script method="MERGE">
    <api:call op="csvproviderUpdate">
      <api:push/>
    </api:call>
  </api:script>

  <!-- Not implemented -->
  <api:script method="DELETE">
    <api:call op="csvproviderDelete">
      <api:push/>
    </api:call>
  </api:script>
</api:script>

Schema.ini ファイルでは、テーブルとしてモデル化したいテキストファイルの形式を指定できます。また、テーブルのカラムも定義できます。 Schema.ini はURI で指定されたフォルダ内に配置する必要があります。あるいは、IncludeSubdirectories が設定されている場合は、Schema.ini を各サブフォルダ内に定義できます。

Schema.ini を必要な場合にのみ定義できるようにするには、IncludeFiles およびExtendedProperties も使用できます。

ExtendedProperties はMicrosoft Jet OLE DB 4.0 と互換性があります。すべてのテキストファイルの形式はExtendedProperties で設定が可能です。Schema.ini は特定のファイルに対してExtendedProperties をオーバーライドします。

Schema.ini で指定されたファイルは、IncludeFiles で追加されたファイルに加えてテーブルとしてレポートされます。Sync App は、テーブルのレポートにSchema.ini の定義を使用します。定義がない場合はファイル名を使用します。

Schema.ini でテーブルを定義

Schema.ini のセクションは、角かっこで囲まれたファイル名で始まる必要があります。次に例を示します。

[Jerrie's travel expense.txt]

ファイル形式を指定

ファイル名のエントリを追加したら、Format プロパティをファイルの形式に設定できます。有効な値は次のとおりです。

• CSVDelimited
• TabDelimited
• Delimited(custom character)

Format=Delimited(,)

カラムを定義

カラムの定義には、テキストファイルのフィールドに基づく2つの方法があります。

• ファイルの一行目、ヘッダー行でカラム名を定義します。接続するとSync App がデータ型を決定します。
• カラム番号、名前、データ型、および幅をSchema.ini で定義します。この方法で定義されたカラムは、最初にヘッダー行から受け取ったカラムをオーバーライドします。Schema.ini のファイルセクションで"ColNameHeader=False" に設定することで、ファイルのヘッダー行を無視することもできます。

Schema.ini でカラムを定義するには、次のフォーマットを使用します。

Coln=ColumnName DataType [Width Width]

次に例を示します。

Col2=A Text Width 100 

Schema.ini の例

[Jerrie's travel expense.csv] 
ColNameHeader=True 
Format=Delimited(,) 
Col1=Date Text 
Col2=A Text 
Col3=B Text 
Col4=C Text 
Col5=Total Text
Col6=Date Text 
Col7=D Text
Col8=E Text 
Col9=F Text 
Col10=G Text
Col11=rate numeric

[invoices.csv] 
ColNameHeader=True 
Format=Delimited(,) 
Col1=id numeric 
Col2=invoicedate date 
Col3=total numeric

サポートされるデータ型

データ型は次のいずれかになります。

• binary
• byte
• boolean
• date
• time
• datetime
• decimal
• double
• tinyint
• smallint
• integer
• bigint
• float
• string
• text
• longtext
• char
• varchar
• nvarchar

CData Sync App を使用すると、スキーマ定義をコンフィギュレーションファイルに保存できます。スキーマファイルを使用すると、動的に検出されたスキーマをカスタマイズして保存したり、独自のデータビューを定義したりすることが容易になります。

次のセクションでは、GenerateSchemaFiles プロパティを使って接続文字列に基づいて検出されたテーブル定義を保存する方法を示します。 あるいは、ストアドプロシージャを呼び出して、指定された入力パラメータに基づいてスキーマファイルを手動で生成することもできます。

スキーマを作成したら、データ型をさらに制御するためにテーブルスキーマを拡張する方法や、CSV をテーブルとしてモデル化するその他の側面についてCSV データのモデリング を参照してください。

GenerateSchemaFiles 接続プロパティの使用

次の追加の接続プロパティを設定して、ローカルまたはリモートCSV のテーブルスキーマを生成します。

• GenerateSchemaFiles：これを設定すると、CSV データソースへの接続 で説明されている接続プロパティで決定されたテーブルのスキーマファイルが生成されます。OnUse に設定した場合、CSV に対してSELECT クエリを実行するとスキーマが生成されます。OnStart に設定すると、接続時にスキーマが生成されます。同じ名前のスキーマファイルがすでに存在する場合、Sync App はファイルを上書きしません。
• Location：このプロパティをスキーマのパスに設定します。Sync App は、すべてのフォルダ内のすべての.rsd ファイルをテーブルとして表示します。Sync App は、すべてのフォルダ内のすべての.rsb ファイルをストアドプロシージャとして表示します。

Note：.rsd ファイルで定義されたカラムはSchema.ini の定義よりも優先されます。生成されたスキーマファイルで定義されたカラムはSchema.ini の定義よりも優先されます。

カラムの基本属性は、カラム名、データ型、カラムが主キーかどうか、および内部名です。Sync App は、内部名を使って読み取り可能な名前のないCSV からノードを取得します。

スキーマファイルのapi:info ブロックにカラム属性をマークアップします。other:internalname プロパティに内部名を設定することができます。結果のカラム値の形式を他のvalueFormat に指定することも可能です。 エンティティ定義の詳細な例を見るには、CSV データのモデリング を参照してください。

<api:info title="CSVPersons" desc="Parse the CSV Persons feed.">
  <attr name="ID"           xs:type="int"        key="true"                                            />
  <attr name="EmployeeID"   xs:type="int"                             other:internalname="employee_id" />
  <attr name="Name"         xs:type="string"                                                           />
  <attr name="TotalExpense" xs:type="double"                                                           />
  <attr name="HireDate"     xs:type="datetime"                                                         />
  <attr name="Salary"       xs:type="int"                                                              />
</api:info>

内部名の定義

other:internalname プロパティは、CSV からカラム値を取得するCSV カラム名を指定するために使われます。したがって、CSV ファイルにemployee_id というカラム名が含まれている場合、other:internalname="employee_id" を使用します。

URL とカラムの定義 が指定されている場合、Sync App はSupportEnhancedSQL を介してクライアント側のインメモリでSELECT ステートメントを処理します。 次のセクションでは、Sync App のビルトインオペレーションを使って、Sync App がどのようにリクエストを出してサーバーからデータを返すかをカスタマイズする方法を示します。

CSV へのSelect の実行

SELECT クエリが発行されると、Sync App は、スキーマのGET メソッドを実行します。このメソッドでは、CSV を処理できます。 このスキーマの詳細な例を見るには、CSV データのモデリング を参照してください。

データの取得

次の行はスキーマをURI にマップします。

<api:set  attr="uri"                      value="ftp://somewebsite/NorthwindOData.csv" />

GET メソッドでデータを取得する処理を呼び出します。api:push キーワードを使って操作を指定します。次の行は、処理の結果をスキーマのアウトプットにプッシュします。

<api:script method="GET" >
  <api:push op="csvproviderGet"/>
</api:script>

データ検索のカスタマイズ

Sync App の操作は、サーバーに送信されるリクエストを高いレベルで制御可能にします。さまざまな入力を設定して、認証やその他のリクエストの側面を制御できます。 利用可能は入力はオペレーション を参照してください。

また、SQL ステートメントからの入力によってリクエストを構築することもできます。例として、次のセクションでは、WHERE 句を使用してリクエストを動的に変更する方法を示します。WHERE 句で指定された他のフィルタはSync App によってクライアント側で処理されます。レスポンスで返されたあらゆるカラムを検索することができます。

CSV で場所の予測を返す天気予報API を考えてみましょう。URI に必要な場所を指定します。Sync App を使用すると、次のようなクエリで予測を取得できます。

SELECT *
FROM Forecasts 
WHERE (Location = '90210') 

下記の手順に従って、このクエリを実装します。次のプロシージャは、疑似カラム、WHERE 句でのみ使用できる入力を定義し、疑似カラムをAPI リクエストにマップします。

1. ロケーション入力パラメータをapi:info ブロックのカラム定義に追加します。
   

   <api:info>
   ...
   <input  name="Location"                 required="true"/>
   </api:info>

2. ロケーション疑似カラムの値を参照します。次の例では、ロケーションはURI に設定されたCSV リソースの名前です。
   

   <api:set attr='uri' value="http://api.wunderground.com/api/MyAPIKey/hourly/q/[_input.Location].csv"/> 

3. 処理を呼び出してリクエストを行い、レスポンスを処理します。
   

   <api:script method="GET" >
   <api:push op="csvproviderGet"/>
   </api:script>

ページングのカスタマイズ

Sync App の内部ページングメカニズムをオーバーライドするには、Rows@Next 入力をapi:info ブロックのカラムリストに追加します。

<input name="rows@next" desc="Identifier for the next page of results." />

<api:set attr="EnablePaging" value="TRUE" />

例えば、API が次ページのURL を応答で返す場合があります。URL にXPath を指定することでこの値を取得できます。

<api:set  attr="elementmappath#"  value="/next_page" />
<api:set  attr="elementmapname#"  value="rows@next" /> 

<api:check attr="_input.rows@next">
<api:set  attr="uri"  value="[_input.rows@next]" />
<api:else>
<api:set  attr="uri"  value="<first page's URL>" />
</api:else>
<api:check> 

SELECT ステートメントのコンポーネントへのアクセス

_query アイテムを使用して、スキーマのSELECT ステートメントのコンポーネントにアクセスできます。

SELECT Id, Name FROM Accounts WHERE City LIKE '%New%' AND COUNTRY = 'US' GROUP BY CreatedDate ORDER BY Name LIMIT 10,50;

City LIKE '%New%' AND COUNTRY = 'US'

Sync App は、CSV データソースからのデータへのアクセスにおいて高いパフォーマンスのビルトインオペレーションを持ちます。これらのオペレーションはプラットフォームを問いません：これらのオペレーションを呼び出すスキーマファイルは、.NET およびJava 両方で使うことができます。Sync App を、.NET またはJava で書かれたユーザー自身のオペレーションによって拡張することも可能です。

Sync App は次のオペレーションによって成り立ちます：

The csvproviderGet operation is an API Script operation that is used to process CSV content. It allows you to split CSV content into rows.

Required Parameters

• URI: The URI parameter specifies the location of the CSV content. This URI scheme can be file:// for local files or can specify a remote data source: http:// (or https://), s3://, gdrive://, box://, or ftp:// (ftps://).

Network Operation

The csvproviderGet operation can be used to execute remote data retrieval operations. It abstracts the request and also enables configuration of most aspects through the following inputs, including authentication and firewall traversal. See ProxyAuthScheme and FirewallType the properties needed to negotiate a firewall.

Column Mapping

The csvproviderGet operation reads the api:info section of the table schema file to map various elements in the CSV document into column values within a row. It does so using the other:internalname property of the column definition.

HTTP

• Method: The HTTP method that corresponds to the SQL data manipulation statement. The allowed values are GET, POST, PUT, DELETE, and MERGE. The default value is GET.
• ContentType: The content type of the HTTP post. Relevant only if data is specified.
• Data: Data to include in the put or the post.
• Text: Input CSV text (an alternative to URI).
• Header:Name#: The name for each custom header to pass with the request.
• Header:Value#: The value for each custom header to pass with the request.
• ParamName#: The name for each parameter to pass with the request.
• ParamValue#: The value for each parameter to pass with the request.
• Cookie:*: Any cookies that should be added to the request.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• LogFile: The file where exchanged/transferred data is logged.

Authentication

• User: The username used for authentication.
• Password: The password used for authentication.
• AuthScheme: The authentication method to use. Only relevant if User and Password are provided. The allowed values are BASIC, DIGEST, NONE, NTLM, NEGOTIATE. The default value is BASIC.
• KerberosKDC: The KDC setting of Kerberos, available when AuthScheme is NEGOTIATE.
• KerberosRealm: The Realm setting of Kerberos, available when AuthScheme is NEGOTIATE.
• KerberosToken: The Kerberos token used for authentication.

OAuth

• Version: The OAuth version. The allowed values are DISABLED, 1.0, 2.0. The default value is DISABLED.
• Token: The access token for OAuth.
• Token_Secret: The access token secret. OAuth 1.0 only.
• Client_Id: The OAuth client Id. OAuth 1.0 only.
• Client_Secret: The OAuth client secret. OAuth 1.0 only.
• Sign_Method: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Other_Options: Other options to control the behavior of OAuth.

Proxy

• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.

Firewall

• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, and SOCKS5. The default value is NONE.

The oauthGetAccessToken operation is an API Script operation that is used to facilitate the OAuth authentication flow. To pass the needed inputs to the operation, define the GetOAuthAccessToken stored procedure and, if your data source has a refresh flow, RefreshOAuthAccessToken. The Sync App can call this internally.

The Sync App includes stored procedures that invoke this operation to complete the OAuth exchange. The following example schema briefly lists some of the typically required inputs before the following sections explain them in more detail.

For a guide to using the Sync App to authenticate, see the "Getting Started" chapter.

Creating a GetOAuthAccessToken Stored Procedure

Invoke the oauthGetAccessToken with the GetOAuthAccessToken stored procedure. The following inputs are required for most data sources and will provide default values for the connection properties of the same name.

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="GetOAuthAccessToken"   description="Obtains the OAuth access token to be used for authentication with various APIs."                                                         >
    <input  name="AuthMode"               desc="The OAuth flow. APP or WEB."                                                                                                                    />
    <input  name="CallbackURL"            desc="The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. " />
    <input  name="OAuthAccessToken"       desc="The request token. OAuth 1.0 only."                                                                                                             />
    <input  name="OAuthAccessTokenSecret" desc="The request token secret. OAuth 1.0 only."                                                                                                      />
    <input  name="Verifier"               desc="The verifier code obtained when the user grants permissions to your app."                                                                       />

    <output name="OAuthAccessToken"       desc="The access token."                                                                                                                              />
    <output name="OAuthTokenSecret"       desc="The access token secret."                                                                                                                       />
    <output name="OAuthRefreshToken"      desc="A token that may be used to obtain a new access token."                                                                                         />
 </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"                                                    value="MyOAuthVersion"                 />
  <!-- Set RequestTokenURL to the URL where the request for the request token is made. OAuth 1.0 only.-->
  <api:set attr="OAuthRequestTokenURL"                                            value="http://MyOAuthRequestTokenURL" />
  <!-- Set OAuthAuthorizationURL to the URL where the user logs into the service and grants permissions to the application. -->
  <api:set attr="OAuthAuthorizationURL"                                           value="http://MyOAuthAuthorizationURL" />
  <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
  <api:set attr="OAuthAccessTokenURL"                                             value="http://MyOAuthAccessTokenURL"   />
  <!-- Set GrantType to the authorization grant type. OAuth 2.0 only. -->
  <api:set attr="GrantType"                                                       value="CODE"                           />
  <!-- Set SignMethod to the signature method used to calculate the signature of the request. OAuth 1.0 only.-->
  <api:set attr="SignMethod"                                                      value="HMAC-SHA1"                      />
  <api:call op="oauthGetAccessToken">
    <api:push/>
  </api:call>
  
</api:script>

Writing the RefreshOAuthAccessToken Stored Procedure

You can also use oauthGetAccessToken to refresh the access token by providing the following inputs:

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="RefreshOAuthAccessToken" description="Refreshes the OAuth access token used for authentication." >
    <input  name="OAuthRefreshToken"        desc="A token that may be used to obtain a new access token."           /> 
    <output name="OAuthAccessToken"         desc="The authentication token returned."                               />
    <output name="OAuthTokenSecret"         desc="The authentication token secret returned. OAuth 1.0 only."        />
    <output name="OAuthRefreshToken"        desc="A token that may be used to obtain a new access token."           />
    <output name="ExpiresIn"                desc="The remaining lifetime on the access token."                      />

  </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"                                                    value="MyOAuthVersion"                 />
    <!-- Set GrantType to REFRESH. OAuth 2.0 only. -->
    <api:set attr="GrantType"            value="REFRESH" />
    <!-- Set SignMethod to the signature method used to calculate the signature of the request. OAuth 1.0 only.-->
    <api:set attr="SignMethod"           value="HMAC-SHA1" />
    <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
    <api:set attr="OAuthAccessTokenURL"  value="http://MyOAuthAccessTokenURL" />
    <!-- Set AuthMode to 'WEB' when calling RefreshOAuthAccessToken -->
    <api:set attr="AuthMode" value="WEB"/>
  <api:call op="oauthGetAccessToken">
    <api:push/>
  </api:call>
  
</api:script>

Input Parameters

• OAuthVersion: The OAuth version. The allowed values are 1.0, 2.0. The default value is 1.0.
• AuthMode: The OAuth flow. OAuth 2.0 only. If you choose the App mode, this operation will launch your browser and prompt you to authenticate with your account credentials. Set this parameter to WEB to authenticate a Web app or if the Sync App is not allowed to open a Web browser. The default value is APP.
• OAuthRequestTokenURL: The URL where the Sync App makes a request for the request token. OAuth 1.0 only. Required for OAuth 1.0.
• OAuthAuthorizationURL: The URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthAccessTokenURL: The URL where the request for the access token is made. In OAuth 1.0, the authorized request token is exchanged for the access token.
• CallbackURL: The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. This value must match the callback URL you specify when you register an app. Note that your data source may additionally require the port.
• OAuthClientId: The client Id obtained when you register an app. Also called a consumer key.
• OAuthClientSecret: The client secret obtained when you register an app. Also called a consumer secret.
• OAuthAccessToken: The request token. OAuth 1.0 only.
• OAuthAccessTokenSecret: The request token secret. OAuth 1.0 only.
• OAuthRefreshToken: A token that may be used to obtain a new access token.
• GrantType: Authorization grant type. OAuth 2.0 only. The allowed values are CODE, PASSWORD, CLIENT, REFRESH. The default value is CODE.
• Verifier: The verifier code obtained when the user grants permissions to the Sync App. In the OAuth 2.0 code grant type, the verifier code is located in the code query string parameter of the callback URL. In OAuth 1.0, the verifier is located in the oauth_verifier query string parameter of the callback URL.
• SignMethod: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Cert: Path for the PFX personal certificate file. OAuth 1.0 only.
• CertPassword: Personal certificate password. OAuth 1.0 only.
• OtherOptions: Other options to control the behavior of OAuth.
• OAuthParam:*: Other parameters.
• PostData: The HTTP POST data.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• LogFile: Specifies a file where the request and response are logged.
• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, SOCKS5. The default value is NONE.
• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.

Output Parameters

• OAuthAccessToken: The access token.
• OAuthTokenSecret: The access token secret.
• OAuthRefreshToken: A token that may be used to obtain a new access token.
• ExpiresIn: The remaining lifetime on the access token.
• OAuthParam:*: Other parameters sent from the server.

The oauthGetUserAuthorizationURL is an API Script operation that is used to facilitate the OAuth authentication flow for Web apps, for offline apps, and in situations where the Sync App is not allowed to open a Web browser. To pass the needed inputs to this operation, define the GetOAuthAuthorizationURL stored procedure. The Sync App can call this internally.

Define stored procedures in .rsb files with the same file name as the schema's title. The example schema briefly lists some of the typically required inputs before the following sections explain them in more detail.

For a guide to authenticating in the OAuth flow, see the "Getting Started" chapter.

Writing the GetOAuthAuthorizationURL Stored Procedure

Call oauthGetUserAuthorizationURL in the GetOAuthAuthorizationURL stored procedure.

<api:script xmlns:api="http://www.rssbus.com/ns/rsbscript/2">

  <api:info title="Get OAuth Authorization URL" description="Obtains the OAuth authorization URL used for authentication with various APIs."                                                          >
    <input  name="CallbackURL"                  desc="The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. " />

    <output name="URL"                          desc="The URL where the user logs in and is prompted to grant permissions to the app. "                                                               />
    <output name="OAuthAccessToken"             desc="The request token. OAuth 1.0 only."                                                                                                             />
    <output name="OAuthTokenSecret"             desc="The request token secret. OAuth 1.0 only."                                                                                                      />
  </api:info>

  <!-- Set OAuthVersion to 1.0 or 2.0. -->
  <api:set attr="OAuthVersion"          value="MyOAuthVersion"                 />
  <!-- Set ResponseType to the desired authorization grant type. OAuth 2.0 only.-->
  <api:set attr="ResponseType"           value="code"                           />
  <!-- Set SignMethod to the signature method used to calculate the signature. OAuth 1.0 only.-->
  <api:set attr="SignMethod"            value="HMAC-SHA1"                      />
  <!-- Set OAuthAuthorizationURL to the URL where the user logs into the service and grants permissions to the application. -->
  <api:set attr="OAuthAuthorizationURL"  value="http://MyOAuthAuthorizationURL" />
  <!-- Set OAuthAccessTokenURL to the URL where the request for the access token is made. -->
  <api:set attr="OAuthAccessTokenURL"   value="http://MyOAuthAccessTokenURL"/>
  <!-- Set RequestTokenURL to the URL where the request for the request token is made. OAuth 1.0 only.-->
  <api:set attr="OAuthRequestTokenURL"   value="http://MyOAuthRequestTokenURL"       />
  <api:call op="oauthGetUserAuthorizationUrl">
    <api:push/>
  </api:call>
  
</api:script>

<p>

Input Parameters

• OAuthVersion: The OAuth version. The allowed values are 1.0, 2.0. The default value is 1.0.
• OAuthAuthorizationURL: The URL where the user logs into the service and grants permissions to the application. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthRequestTokenURL: The URL where the Sync App makes a request for the request token. OAuth 1.0 only. Required for OAuth 1.0.
• CallbackURL: The URL to be used as a trusted redirect URL, where the user will return with the token that verifies that they have granted your app access. This value must match the callback URL you specify when you register an app. Note that your data source may additionally require the port. The default value is http://127.0.0.1/.
• OAuthClientId: The client Id. Also called a consumer key.
• OAuthClientSecret: The client secret. Also called a consumer secret.
• ResponseType: The desired authorization grant type. OAuth 2.0 only. The allowed values are CODE, IMPLICIT. The default value is CODE.
• SignMethod: The signature method used to calculate the signature for OAuth 1.0. The allowed values are HMAC-SHA1, RSA-SHA1, PLAINTEXT. The default value is HMAC-SHA1.
• Cert: Path for the personal certificate PFX file. OAuth 1.0 only.
• CertPassword: Personal certificate password. OAuth 1.0 only.
• OtherOptions: Other options to control the behavior of OAuth.
• OAuthParam:*: Other parameters. OAuth 1.0 only.
• Timeout: The timeout, in seconds, for the operation to complete. Zero (0) means no timeout. The default value is 60.
• Proxy_Auto: Whether or not the proxy should be detected from Windows system settings. This takes precedence over other proxy settings and is not available in Java. The allowed values are TRUE, FALSE. The default value is FALSE.
• Proxy_Server: IP address or host name of the proxy server used for the request.
• Proxy_Port: The port number of the proxy server.
• Proxy_User: The user Id used to authenticate with the proxy server.
• Proxy_Password: The password used to authenticate with the proxy server.
• Proxy_AuthScheme: The authentication scheme of the proxy server. The allowed values are BASIC, DIGEST, PROPRIETARY, NONE, NTLM. The default value is BASIC.
• Proxy_AuthToken: The proxy authentication token.
• Proxy_SSLType: The SSL type of the proxy server. The allowed values are AUTO, ALWAYS, NEVER, TUNNEL. The default value is AUTO.
• Firewall_Type: The type of the firewall. The allowed values are NONE, TUNNEL, SOCKS4, SOCKS5. The default value is NONE.
• Firewall_Server: The IP address or host name of the firewall.
• Firewall_Port: The port number of the firewall.
• Firewall_User: The user Id used to authenticate with the firewall.
• Firewall_Password: The password used to authenticate with the firewall.

Output Parameters

• URL: The URL where the user logs in and is prompted to grant permissions to the app. In OAuth 1.0, if permissions are granted the request token is authorized.
• OAuthAccessToken: The request token. OAuth 1.0 only.
• OAuthTokenSecret: The request token secret. OAuth 1.0 only.
• OAuthParam:*: Other parameters sent from the server. OAuth 1.0 only.

このセクションでは、CSV Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App はユーザー定義ビューの使用をサポートします。これは事前設定されたユーザー定義クエリによって内容が決定される仮想テーブルです。 このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。 カスタムビューの作成と設定の概要については、ユーザー定義ビュー を参照してください。

SSL の設定

SSL の設定 を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、「接続文字列オプション」にあるSSLServerCert プロパティを参照してください。

ファイアウォールとプロキシ

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシ に合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

詳しくは、クエリ処理 を参照してください。

ログ

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

クライアントSSL 証明書

CSV Sync App はクライアント証明書の設定もサポートしています。次を設定すれば、クライアント証明書を使って接続できます。

• SSLClientCert：クライアント証明書のための証明書ストア名。
• SSLClientCertType：TLS / SSL クライアント証明書を格納するキーストアの種類。
• SSLClientCertPassword：TLS / SSL クライアント証明書のパスワード。
• SSLClientCertSubject：TLS / SSL クライアント証明書のサブジェクト。

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

• ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
• ProxyPort：プロキシサーバーが起動しているTCP ポート。
• ProxyAuthScheme：プロキシサーバーに対して認証する際にSync App が使用する認証方法。
• ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
• ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

• プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
• 接続をトンネルするには、FirewallType をTUNNEL に設定します。
• 認証するには、FirewallUser とFirewallPassword を設定します。
• SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

Authentication

Connection

AWS Authentication

Azure Authentication

SSO

JWT OAuth

Kerberos

OAuth

SSL

SSH

Firewall

Proxy

Logging

Schema

Data Formatting

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

リモートサービスに接続する際に使用する認証の種類。

解説

Amazon S3

ConnectionType をAmazon S3 に設定する場合、以下のオプションが利用できます。

• AwsRootKeys：ルートユーザーのアクセスキーおよびシークレットを使用する場合に設定。簡易なテストには便利ですが、本番環境のユースケースでは、権限を絞ったものを使用することをお勧めします。
• AwsEC2Roles：CData Sync App が現在実行されているEC2 マシンに割り当てられたIAM ロールを、自動的に使用する場合に設定。
• AwsIAMRoles：接続にIAM ロールを使用する場合に設定。
• ADFS：ADFS をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• OKTA：OKTA をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• PingFederate：PingFederate をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• AwsTempCredentials：一時的なセキュリティ認証情報を、セッショントークンと一緒に利用して接続する場合に設定。
• AwsCredentialsFile：認証に認証情報ファイルを使用する場合に設定。
• AzureAD：AzureAD をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。

Azure の各種サービス

ConnectionType をAzure Blob Storage、Azure Data Lake Storage Gen1、Azure Data Lake Storage Gen2、Azure Data Lake Storage Gen2 SSL、OneDrive のいずれかに設定する場合、以下のオプションが利用可能です。

• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureMSI：Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得する場合に設定。
• AzureServicePrincipal：Azure サービスプリンシパルとして認証する場合に設定。
• AzureServicePrincipalCert：証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。
• AccessKey：CSV アカウントに関連付けられているストレージキーで認証する場合に設定。
• AzureStorageSAS：共有アクセス署名（SAS）で認証する場合に設定。

OneLake

ConnectionType をOneLake に設定する場合、以下のオプションが利用できます。

• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureMSI：Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得する場合に設定。
• AzureServicePrincipal：Azure サービスプリンシパルとして認証する場合に設定。
• AzureServicePrincipalCert：証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。

Azure Files

• AccessKey：CSV アカウントに関連付けられているストレージキーで認証する場合に設定。
• AzureStorageSAS：共有アクセス署名（SAS）で認証する場合に設定。

Box

ConnectionType をBox に設定する場合、以下のオプションが利用できます。

• OAuth：標準のユーザーアカウントを使用してOAuth2 を使用します。OAuthVersion は2.0に設定する必要があります。
• OAuthClient：クライアントクレデンシャルグラントタイプで OAuth2 を使用します。OAuthClientId およびOAuthClientSecret はクレデンシャルです。OAuthVersion は2.0に設定する必要があります。
• OAuthJWT：JWT ベアラーグラント種別でOAuth2 を使用します。OAuthJWTCertType およびOAuthJWTCert は、JWT がどの証明書で署名されるかを決定します。OAuthVersion は2.0に設定する必要があります。

Dropbox

ConnectionType をDropbox に設定する場合、以下のオプションのみ利用できます。

OAuth：認可コードグラントタイプでOAuth2 を使用します。OAuthVersion は2.0に設定する必要があります。

FTP(S)

ConnectionType をFTP またはFTPS に設定する場合、以下のオプションのみ利用できます。

Basic：基本的なユーザー資格情報（ユーザー / パスワード）。

Google の各種サービス

ConnectionType がGoogle Cloud Storage またはGoogle Drive を指している場合、以下のオプションが利用できます。

• OAuth：標準のユーザーアカウントを使用してOAuth2 を使用します。OAuthVersion は2.0に設定する必要があります。
• OAuthPKCE：認可コードグラントタイプとPKCE 拡張機能を持つOAuth2を使用します。OAuthVersion は2.0に設定する必要があります。
• OAuthJWT：JWT ベアラーグラント種別でOAuth2 を使用します。OAuthJWTCertType およびOAuthJWTCert は、JWT がどの証明書で署名されるかを決定します。OAuthVersion は2.0に設定する必要があります。
• GCPInstanceAccount：GCP 仮想マシン上で実行している場合は、プロバイダーは仮想マシンに関連付けられたサービスアカウントを使用して認証できます。

HDFS

ConnectionType をHDFS またはHDFS Secure に設定する場合、以下のオプションが利用できます。

• None：認証なし。
• Negotiate：Kerberos 認証。

HTTP

ConnectionType をHTTP またはHTTPS に設定する場合、以下のオプションが利用できます。

• None：認証なし。
• Basic：基本的なユーザー / パスワード認証。
• Digest：User およびPassword でHTTP Digest 認証を使用します。
• OAuth：OAuth1 またはOAuth2 のいずれかを使用します。OAuth のどのバージョンを使用するかを決定するには、OAuthVersion を設定する必要があります。
  • ベアラートークン認証：AuthScheme=OAuth、InitiateOAuth=Off、およびOAuthAccessToken=Bearer token value。
• OAuthJWT：JWT ベアラーグラント種別でOAuth2 を使用します。OAuthJWTCertType およびOAuthJWTCert は、JWT がどの証明書で署名されるかを決定します。OAuthVersion は2.0に設定する必要があります。
• OAuthPassword：パスワードグラント種別でOAuth2 を使用します。User およびPassword は資格情報です。OAuthVersion は2.0に設定する必要があります。
• OAuthClient：クライアント資格情報グラント種別でOAuth2 を使用します。OAuthClientId およびOAuthClientSecret は資格情報です。OAuthVersion は2.0に設定する必要があります。
• OAuthPKCE：認証コードグラント種別とPKCE 拡張仕様でOAuth2 を使用します。OAuthClientId は資格情報です。OAuthVersion は2.0に設定する必要があります。

IBM Cloud Object Storage

ConnectionType をIBM Object Storage Source に設定する場合、以下のオプションも利用できます。

• OAuth：InitiateOAuth によって決定された特定のフローでOAuthを使用します。ApiKey が設定されていないと、このフローは正常に終了しません。
• HMAC：AccessKey およびSecretKey を使用して、IBM Cloud Object Storage を認証します。

Oracle Cloud Storage

ConnectionType をOracle Cloud Storage に設定する場合、以下のオプションのみ利用できます。

HMAC：AccessKey およびSecretKey を使用して、Oracle Cloud Storage を認証します。

SFTP

このConnectionType は、SFTP というAuthScheme を使用するのがデフォルトですが、実際は認証方式はSSHAuthMode プロパティを使用して制御されます。詳しくは、このプロパティのドキュメントを参照してください。

SharePoint REST

ConnectionType をSharePoint REST に設定する場合、以下のオプションも利用できます。

• AzureAD：Azure Active Directory OAuth 認証を実行する場合に設定。
• AzureMSI：Azure VM で実行しているときに、マネージドサービスID の資格情報を自動的に取得する場合に設定。
• AzureServicePrincipal：Azure サービスプリンシパルとして認証する場合に設定。
• AzureServicePrincipalCert:証明書を使用してAzure サービスプリンシパルとして認証する場合に設定。

SharePoint SOAP

ConnectionType をSharePoint SOAP に設定する場合、以下のオプションも利用できます。

• Basic：認証には、基本的なユーザー / パスワード資格情報を使用。
• ADFS：ADFS をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• Okta：OKTA をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。
• OneLogin：OneLogin をID プロバイダーとしたシングルサインオン接続を使用する場合に設定。

アカウントのアクセスキー。この値にはセキュリティ認証情報ページからアクセスできます。

解説

アカウントのアクセスキー。この値には、使用しているサービスに応じたセキュリティ認証情報ページからアクセスできます。

アカウントのシークレットキー。この値にはセキュリティ認証情報ページからアクセスできます。

解説

アカウントのシークレットキー。この値には、使用しているサービスに応じたセキュリティ認証情報ページからアクセスできます。

IBM Cloud にユーザーを識別させるためのAPI キー。

解説

CSV REST API のリソースへのアクセスは、トークンを取得するためのAPI キーで管理されています。API キーは、［Manage（管理）］->［Access（IAM）］->［Users（ユーザー）］と移動して、［Create（作成）］をクリックすることで作成できます。

認証に使用されるユーザーアカウント。

解説

このフィールドは、Password とともにサーバーに対して認証するために使われます。

このプロパティは、ConnectionType およびAuthScheme の値に応じて、異なる値を指します。

• ConnectionType=AmazonS3
  • AuthScheme=ADFS：ADFS のユーザー名です。
  • AuthScheme=Okta：Okta のユーザー名です。
  • AuthScheme=PingFederate：PingFederate のユーザー名です。
• ConnectionType=FTP(S)
  • AuthScheme=Basic：FTP(S) サーバーのユーザー名です。
• ConnectionType=HDFS/HDFS Secure
  • AuthScheme=Negotiate：HDFS インスタンスのユーザー名です。
• ConnectionType=HTTP(S)
  • AuthScheme=Basic：HTTP ストリームに関連付けられたユーザー名です。
  • AuthScheme=Digest：HTTP ストリームに関連付けられたユーザー名です。
  • AuthScheme=OAuthPassword：HTTP ストリームに関連付けられたユーザー名です。
• ConnectionType=SharePoint SOAP
  • AuthScheme=Basic：SharePoint アカウントのユーザー名です。
  • AuthScheme=ADFS：ADFS のユーザー名です。
  • AuthScheme=Okta：Okta のユーザー名です。
  • AuthScheme=OneLogin：OneLogin のユーザー名です。

ユーザーの認証に使用するパスワード。

解説

User およびPassword を一緒に使用してサーバーで認証を行います。

このプロパティは、ConnectionType およびAuthScheme の値に応じて、異なる値を指します。

• ConnectionType=AmazonS3
  • AuthScheme=ADFS：ADFS のパスワードです。
  • AuthScheme=Okta：Okta のパスワードです。
  • AuthScheme=PingFederate：PingFederate のパスワードです。
• ConnectionType=FTP(S)
  • AuthScheme=Basic：FTP(S) サーバーのパスワードです。
• ConnectionType=HDFS/HDFS Secure
  • AuthScheme=Negotiate：HDFS インスタンスのパスワードです。
• ConnectionType=HTTP(S)
  • AuthScheme=Basic：HTTP ストリームに関連付けられたパスワードです。
  • AuthScheme=Digest：HTTP ストリームに関連付けられたパスワードです。
  • AuthScheme=OAuthPassword：HTTP ストリームに関連付けられたパスワードです。
• ConnectionType=SharePoint SOAP
  • AuthScheme=Basic：SharePoint アカウントのパスワードです。
  • AuthScheme=ADFS：ADFS のパスワードです。
  • AuthScheme=Okta：Okta のパスワードです。
  • AuthScheme=OneLogin：OneLogin のパスワードです。

使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

解説

使用しているSharePoint のエディション。SharePointOnline またはSharePointOnPremise のいずれかに設定します。

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

解説

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode. The Admin mode is available only for Enterprise with Governance accounts and will be upon request. It will not work for any other accounts.

このセクションでは、本プロバイダーの接続文字列で設定可能なConnection プロパティの全リストを提供します。

CSV のファイルが保存および取得されるファイルストレージサービス、サーバー、またはファイルアクセスプロトコルを指定します。

解説

ConnectionType を以下のいずれかに設定します。

• Local：CSV のファイルはローカルマシンに保存されます。
• Amazon S3
• Azure Blob Storage
• Azure Data Lake Storage Gen1
• Azure Data Lake Storage Gen2
• Azure Data Lake Storage Gen2 SSL
• Azure Files
• Box
• Dropbox
• FTP
• FTPS
• Google Cloud Storage
• Google Drive
• HDFS
• HDFS Secure
• HTTP：HTTP Streams でホストされているCSV ファイルに接続します。
• HTTPS：HTTPS Streams でホストされているCSV ファイルに接続します。
• IBM Object Storage Source
• OneDrive
• OneLake
• Oracle Cloud Storage
• SFTP
• SharePoint REST
• SharePoint SOAP
• Custom Stream

ConnectionType を以下のいずれかに設定します。

• Local：CSV のファイルはローカルマシンに保存されます。
• Amazon S3
• Azure Blob Storage
• Azure Data Lake Storage Gen1
• Azure Data Lake Storage Gen2
• Azure Data Lake Storage Gen2 SSL
• Azure Files
• Box
• Dropbox
• FTP
• FTPS
• Google Cloud Storage
• Google Drive
• HDFS
• HDFS Secure
• HTTP：HTTP Streams でホストされているCSV ファイルに接続します。
• HTTPS：HTTPS Streams でホストされているCSV ファイルに接続します。
• IBM Object Storage Source
• OneDrive
• OneLake
• Oracle Cloud Storage
• SFTP
• SharePoint REST
• SharePoint SOAP
• Custom Stream

CSV リソースロケーションのUniform Resource Identifier (URI)。

解説

URI プロパティを設定して、ファイルまたはストリームへのパスを指定します。

NOTE：

• この接続プロパティでは、ConnectionType を設定する必要があります。
• ディレクトリパスを指定する場合は、一般的に'folder1' ではなく'folder1/' のように、URI の末尾にパス区切り文字を付けることが推奨されます。

複数ファイルのパースおよびマージに使用できる、より高度な機能については、 を参照してください。

以下は、使用可能なデータソースのURI 形式の例です。

接続文字列とクエリの例

以下は、CSV ファイルまたはストリームへの接続文字列の例です。

S3ライクなWeb サービスのホスティングリージョン。

解説

S3ライクなWeb サービスのホスティングリージョン。

Oracle Cloud Object Storage のリージョン

Wasabi のリージョン

Google Cloud Storage インスタンスが存在するプロジェクトのId。

解説

Google Cloud Storage インスタンスが存在するプロジェクトのId。この値は、Google Cloud コンソールにアクセスして左上画面のプロジェクト名をクリックすると確認できます。ProjectId は一致するプロジェクトのId カラムに表示されます。

使用するOracle Cloud Object Storage ネームスペース。

解説

使用するOracle Cloud Object Storage ネームスペース。リクエストを行う前に、この設定をOracle Cloud アカウントに関連付けられてたOracle Cloud Object Storage ネームスペースに設定する必要があります。お使いのアカウントのObject Storage ネームスペースを検索する方法については、Oracle Cloud ドキュメントのUnderstanding Object Storage Namespaces ページを参照してください。

クラウドストレージサービスプロバイダーのURL。

解説

このプロパティは、以下を指定するために使われます。

• カスタムS3サービスのURL。
• SharePoint SOAP / REST クラウドストレージサービスプロバイダーに必要なURL。

  このオプションのドメインが-my で終わる場合（例えば、https://bigcorp-my.sharepoint.com）、sp:// またはsprest:// スキームの代わりに onedrive:// スキームを使用する必要がある場合があります。

この設定はしきい値をバイト単位で設定します。このしきい値を超えると、provider は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。

解説

この設定はしきい値をバイト単位で設定します。このしきい値を超えると、Sync App は1つのリクエストですべてをアップロードするのではなく、マルチパートでアップロードを実行します。

True（デフォルト）の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます：http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します：http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

解説

True（デフォルト）の場合、バケットはホスト形式のリクエストを使用してリクエストで参照されます：http://yourbucket.s3.amazonaws.com/yourobject。False に設定した場合、Bean はパス形式のリクエストを使用します：http://s3.amazonaws.com/yourbucket/yourobject。S3ベースのカスタムサービスの場合、CustomURL が指定されていると、このプロパティはFalse に設定されることに注意してください。

このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。

解説

このプロパティがtrue に設定される場合、AWSLakeFormation サービスは、設定されたIAM ロールに基づくユーザーに対してアクセスポリシーを適用する一時的な資格情報を取得するために使用されます。このサービスは、SAML アサーションを提供した上で、OKTA、ADFS、AzureAD、PingFederate 経由で認証する場合に使用できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なAWS Authentication プロパティの全リストを提供します。

AWS アカウントのアクセスキーを指定します。この値には、AWS セキュリティ認証情報ページからアクセスできます。

解説

AWS アカウントのアクセスキーを見つけるには、次の手順に従います。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択します。
3. メニューでMy Security Credentials を選択します。
4. Continue to Security Credentials をクリックします。
5. ルートアカウントのアクセスキーを表示または管理するには、Access Keys セクションを展開します。

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

解説

AWS アカウントのシークレットキー。この値には、［AWS セキュリティ認証情報］ページからアクセスできます。

1. ルートアカウントの認証情報を使用してAWS 管理コンソールにサインインします。
2. アカウント名または番号を選択し、表示されたメニューで［My Security Credentials］を選択します。
3. ［Continue to Security Credentials］をクリックし、［Access Keys］セクションを展開して、ルートアカウントのアクセスキーを管理または作成します。

認証時に使用するロールのAmazon リソースネーム。

解説

AWS の外部で認証する場合は、AWS アカウント認証情報ではなく、ロールを認証に使用するのが 一般的です。AWSRoleARN を入力すると、CData Sync App はAWSAccessKey とAWSSecretKey を直接 使用する代わりに、ロールベースの認証を実行します。この認証を実行するためには、AWSAccessKey と AWSSecretKey を指定する必要があります。RoleARN を設定するときは、AWS ルートユーザーの 認証情報を使用できません。AWSAccessKey およびAWSSecretKey はIAM ユーザーのものである必要があります。

AWS アカウントのSAML ID プロバイダーのARN。

解説

AWS アカウントのSAML ID プロバイダーのARN。

Amazon Web サービスのホスティングリージョン。

解説

Amazon Web サービスのホスティングリージョン。利用可能な値は、OHIO、NORTHERNVIRGINIA、NORTHERNCALIFORNIA、OREGON、CAPETOWN、HONGKONG、HYDERABAD、JAKARTA、MALAYSIA、MELBOURNE、MUMBAI、OSAKA、SEOUL、SINGAPORE、SYDNEY、TOKYO、CENTRAL、CALGARY、BEIJING、NINGXIA、FRANKFURT、IRELAND、LONDON、MILAN、PARIS、SPAIN、STOCKHOLM、ZURICH、TELAVIV、BAHRAIN、UAE、SAOPAULO、GOVCLOUDEAST、GOVCLOUDWEST、ISOLATEDUSEAST、ISOLATEDUSEASTB、ISOLATEDUSWEST、およびISOLATEDEUWEST です。

認証に使用するAWS クレデンシャルファイルへのパス。

解説

認証に使用するAWS クレデンシャルファイルへのパス。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。

提供されたAWSCredentialsFile から使用されるプロファイルの名前。

解説

提供されたAWSCredentialsFile から使用されるプロファイルの名前。詳しくは、https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-files.html を参照してください。

AWS のセッショントークン。

解説

AWS のセッショントークン。この値はさまざまな方法で取得できます。詳しくは、this link を参照してください。

他のアカウントでロールを引き受ける際に必要となる一意の識別子。

解説

他のアカウントでロールを引き受ける際に必要となる一意の識別子。

MFA デバイスが使用されている場合は、そのシリアル番号。

解説

AWS マネジメントコンソールにアクセスしてユーザーのセキュリティ認証情報を表示することで、IAM ユーザーのデバイスを見つけることができます。 仮想デバイスの場合、これは実際にはAmazon リソースネームです（ arn:aws:iam::123456789012:mfa/user など）。

MFA デバイスから利用できる一時トークン。

解説

MFA が必要な場合、この値はログインのためのテンポラリクレデンシャルを取得するためにMFASerialNumber とともに使用されます。 AWS から入手可能な一時的な認証情報はデフォルトで最長1時間しか持続しません（TemporaryTokenDuration を参照してください）。時間が経過したら、新しい認証情報を取得できるように、接続を 更新して新しいMFA トークンを指定する必要があります。 %AWSpSecurityToken; %AWSpTemporaryTokenDuration;

一時トークンが持続する時間（秒単位）。

解説

一時トークンは、MFA 認証とロールベース認証の両方で使用されます。一時トークンは、やがてタイムアウトします。 そのときには、新しい一時トークンを取得する必要があります。MFA が使用されていない状況では、これは大したこと ではありません。一時トークンが期限切れになると、CData Sync App は内部的に新しい一時トークンをリクエストします。

ただし、MFA が必要な接続の場合は、新しい一時トークンを取得するために新しいMFAToken を接続で指定 する必要があります。これは、ユーザーによる接続の更新が必要になるため、より煩わしい問題です。指定できる 最大値と最小値は、使用されている接続によって大きく異なります。

ロールベース認証の場合は、最小期間は900秒（15分）で、最大期間は3600秒（1時間）です。 ロールベース認証でMFA が使用されている場合でも、3600秒が依然として最大です。

MFA 認証自体では（IAM ユーザーまたはルートユーザーを使用）、最小値は900秒（15分）、 最大値は129600（36時間）です。

ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。

解説

ID プロバイダーが提供するOAuth 2.0 アクセストークンまたはOpenID Connect ID トークン。 アプリケーションは、Web ID プロバイダーでユーザーを認証することで、このトークンを取得できます。 指定しない場合、この接続プロパティの値は、 環境変数'AWS_WEB_IDENTITY_TOKEN_FILE' の値から自動的に取得されます。

有効にすると、Amazon S3バケットへのファイルアップロードがサーバー側で暗号化されます。

解説

サーバー側の暗号化とは、データを受信するアプリケーションまたはサービスによって、送信先でデータを暗号化することです。Amazon S3は、データセンターのディスクに書き込まれるときにデータをオブジェクトレベルで暗号化し、ユーザーがデータにアクセスするときに復号します。詳しくは、こちらを参照してください。https://docs.aws.amazon.com/ja_jp/AmazonS3/latest/userguide/serv-side-encryption.html

A BASE64-encoded UTF-8 string holding JSON which represents a string-string (key-value) map.

解説

Example of what the JSON may look decoded: {"aws:s3:arn": "arn:aws:s3:::_bucket_/_object_"}.

Configuration to use an S3 Bucket Key at the object level when encrypting data with AWS KMS. Enabling this will reduce the cost of server-side encryption by lowering calls to AWS KMS.

解説

Configuration to use an S3 Bucket Key at the object level when encrypting data with AWS KMS. Enabling this will reduce the cost of server-side encryption by lowering calls to AWS KMS.

A symmetric encryption KeyManagementService key, that is used to protect the data when using ServerSideEncryption.

解説

A symmetric encryption KeyManagementService key, that is used to protect the data when using ServerSideEncryption.

このセクションでは、本プロバイダーの接続文字列で設定可能なAzure Authentication プロパティの全リストを提供します。

Azure ストレージアカウント名。

解説

Azure ストレージアカウントの名前。

Azure アカウントに関連付けられているストレージキー。

解説

CSV アカウントに関連付けられているストレージキー。以下のように取得できます：

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定で［アクセスキー］をクリックします。
4. ページ上にストレージアカウント名とキーが表示されます。

認証に使用可能な共有アクセスキー署名。

解説

共有アクセス署名。以下の手順で作成することができます。

1. ルートアカウントの資格情報を使用してAzure ポータルにサインインします。（https://portal.azure.com/）
2. ストレージアカウントをクリックして、使用するストレージアカウントを選択します。
3. 設定で［Shared Access Signature］をクリックします。
4. 権限およびトークンの有効期限を設定します。
5. ［Generate SAS］をクリックするとトークンをコピーできます。

データにアクセスするために使用されるCSV テナントを、名前（例えば、contoso.omnicrosoft.com）またはID で識別します。（条件付き）

解説

テナントは、主にドメイン（例えば、microsoft.com）に関連付けられた、組織のデジタル表現です。 テナントは、Tenant ID（ディレクトリID とも呼ばれる）によって管理されます。これは、Azure リソースへのアクセスや管理権限をユーザーに割り当てる際に指定します。

Azure ポータルでディレクトリID を見つけるには、Azure Active Directory -> プロパティに移動します。

AuthScheme = AzureServicePrincipal またはAzureServicePrincipalCert のいずれかである場合、またはAzureTenant = AzureAD であり、ユーザーが複数のテナントに属している場合は、AzureTenant を指定する必要があります。

接続するAzure ネットワーク環境を指定します。Azure アカウントが追加されたネットワークと同じである必要があります。

解説

Azure アカウントがGlobal ネットワークとは異なるネットワーク（China、USGOVT、USGOVTDOD など）の一部である場合は、必要です。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSO プロパティの全リストを提供します。

ID プロバイダーのログインURL。

解説

ID プロバイダーのログインURL。

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。

解説

ID プロバイダーへの接続に必要な追加プロパティを、セミコロンで区切ったリスト形式で指定します。SSOLoginURL と一緒に使用します。

SSO 設定については、 で詳しく説明します。

SAML 応答を処理してサービスの資格情報と交換するために使用するURL。

解説

CData Sync App はここで指定されたURL を使用してSAML 応答を処理し、サービスの資格情報と交換します。 取得した資格情報はSSO 接続時の最後の情報であり、CSV との通信に使用されます。

このセクションでは、本プロバイダーの接続文字列で設定可能なJWT OAuth プロパティの全リストを提供します。

JWT 証明書のストア。

解説

クライアント証明書のための証明書ストア名。

OAuthJWTCertType フィールドは、OAuthJWTCert により指定された証明書ストアの種類を指定します。 ストアがパスワードで保護されている場合は、OAuthJWTCertPassword でパスワードを指定します。

OAuthJWTCert は、OAuthJWTCertSubject フィールドとともにクライアント証明書を指定するために使われます。 OAuthJWTCert に値がある場合で、OAuthJWTCertSubject が設定されている場合は、証明書の検索が始まります。 詳しくは、OAuthJWTCertSubject フィールドを参照してください。

証明書ストアの指定はプラットフォームに依存します。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

Javaでは、証明書ストアは通常、証明書および任意の秘密キーを含むファイルです。

証明書ストアの種類がPFXFile の場合は、このプロパティにファイル名を設定します。 PFXBlob の場合は、このプロパティをPFX ファイルのバイナリコンテンツ（例えば、PKCS12証明書ストア）に設定する必要があります。

JWT 証明書を格納するキーストアの種類。

解説

このプロパティには次の値の一つを設定できます。

OAuth JWT 証明書のパスワード。パスワードを必要とする証明書ストアにアクセスするために使用されます。証明書ストアがパスワードを必要としない場合は、このプロパティを空白のままにします。

解説

このプロパティは、証明書ストアを開くために必要なパスワードを指定します。ただし、ストアの種類がパスワードを必要とする場合に限ります。 パスワードが必要かどうかを判断するには、ご利用の証明書ストアのドキュメントまたは設定を参照してください。

GOOGLEJSON OAuthJWTCertType を使用する場合は必要ありません。Google JSON キーは暗号化されていません。

OAuth JWT 証明書のサブジェクトで、ストアで一致する証明書を検索するために使用されます。部分一致と、先頭の証明書を選択するためのワイルドカード '*' をサポートします。

解説

このプロパティの値は、ストアで一致する証明書を検索するために使用されます。検索プロセスは以下のように動作します。

• サブジェクトに完全に一致する証明書が見つかれば、該当する証明書が選択されます。
• 完全に一致するものがない場合、ストアは、サブジェクトがプロパティ値を含む証明書を検索します。
• 一致する証明書がない場合、証明書は選択されません。

値を '*' に設定すると、ストアの先頭の証明書が自動的に選択されます。 証明書のサブジェクトは識別名フィールドおよび値のカンマ区切りのリストです。 例：CN=www.server.com, OU=test, C=US, [email protected]。一般的なフィールドには以下のものが含まれます。

フィールド値にカンマが含まれる場合は、引用符で囲んでください。例："O=ACME, Inc."。

JWT 認証のサブタイプ。

解説

JWT 認証のサブタイプ。要求されているトークンの種類に応じて［enterprise］または［user］に設定します。

JWT の公開キーのID。

解説

JWT の公開キーのID。アプリケーション設定の公開キーID の値に設定します。

このセクションでは、本プロバイダーの接続文字列で設定可能なKerberos プロパティの全リストを提供します。

ユーザーの認証で使用されるKerberos キー配布センター（KDC）サービス。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Sync App は、Kerberos KDC サービスにセッションチケットと一時セッションキーを要求します。Kerberos KDC サービスは、通常、ドメインコントローラーと同じコンピュータに置かれています。

Kerberos KDC が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからKDC を取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)。
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App は設定されているドメイン名およびホストからそれらを推測します。

ユーザー認証に使用されるKerberos 領域。

解説

Kerberos のプロパティは、SPNEGO またはWindows 認証を使用する場合に使用されます。Kerberos 領域は、Kerberos キー配布センター（KDC）サービスを使用してユーザーを認証するために使用されます。Kerberos 領域は、管理者が任意の文字列に設定できますが、通常はドメイン名に基づいて設定されます。

Kerberos 領域が指定されていない場合、Sync App は、これらのプロパティを自動的に次の場所から検出しようとします。

• KRB5 Config File (krb5.ini/krb5.conf)： KRB5_CONFIG 環境変数が設定され、ファイルが存在する場合、Sync App は指定されたファイルからデフォルトレルムを取得します。それ以外の場合は、OS に基づいてデフォルトのMIT ロケーションからの読み取りを試みます：C:\ProgramData\MIT\Kerberos5\krb5.ini (Windows) または/etc/krb5.conf (Linux)
• ドメイン名およびホスト： Kerberos 領域およびKerberos KDC が別の場所から推測できなかった場合、Sync App はユーザー設定されているドメイン名およびホストからそれらを推測します。これは、一部のWindows 環境で機能します。

Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）。

解説

Kerberos ドメインコントローラーのSPN が認証先のURL と異なる場合は、このプロパティを使用してSPN を設定します。

Kerberos ドメインコントローラーのプリンシパル名。host/user@realm の形式で使用されます。

解説

データベースに使用しているユーザーがKerberos データベース内のユーザーと一致しない場合、これをKerberos プリンシパル名に設定する必要があります。

Kerberos プリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

解説

Kerberos のプリンシパルと暗号化されたキーのペアを含むKeytab ファイル。

サービスのKerberos レルム。

解説

KerberosServiceRealm は、クロスレルムKerberos 認証を使用するときにサービスKerberos レルムを指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

サービスのKerberos KDC。

解説

KerberosServiceKDC は、クロスレルムKerberos 認証を使用するときにサービスKerberos KDC を指定するために使われます。

ほとんどの場合、単一のレルムとKDC マシンがKerberos 認証を実行するために使用され、このプロパティは必要ありません。

このプロパティは、異なるレルムとKDC マシンを使用して認証チケット（AS リクエスト）およびサービスチケット（TGS リクエスト）を取得する、より複雑な設定で使用できます。

MIT Kerberos 資格情報キャッシュファイルへのフルパス。

解説

このプロパティは、MIT Kerberos チケットマネージャーまたはkinit コマンドを使用して作成された資格情報キャッシュファイルを使用する場合に設定できます。

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

使われているOAuth のバージョン。

解説

使われているOAuth のバージョン。次のオプションが利用可能です：1.0,2.0

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントId を指定します。（コンシューマーキーとも呼ばれます。）このID は、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientId は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

カスタムOAuth アプリケーションの作成時に割り当てられたクライアントシークレットを指定します。（ コンシューマーシークレット とも呼ばれます。）このシークレットは、カスタムアプリケーションをOAuth 認可サーバーに登録します。

解説

OAuthClientSecret は、ユーザーがOAuth 経由で認証を行う前に設定する必要があるいくつかの接続パラメータの1つです。詳細は接続の確立を参照してください。

The user subject for which the application is requesting delegated access.

解説

Id of the user or enterprise, based on the configuration set in SubjectType.

The Subject Type for the Client Credentials authentication.

解説

The Subject Type for the Client Credentials authentication. Set this to "enterprise" or "user" depending on the type of token being requested.

認証ユーザーのアプリケーションへのアクセス範囲を指定します。 通常は、カスタムOAuth アプリケーションが作成される際に（必要に応じて）指定されます。これにより、認証ユーザーは自身の資格情報に応じて適切なレベルのアクセス権を得ることができます。

解説

スコープは、認証ユーザーがどのようなアクセス権を持つかを定義するために設定されます。例えば、読み取り、読み取りと書き込み、機密情報への制限付きアクセスなどです。システム管理者は、スコープを使用して機能またはセキュリティクリアランスによるアクセスを選択的に有効化できます。

InitiateOAuth がGETANDREFRESH に設定されている場合、要求するスコープを変更したい場合はこのプロパティを使用する必要があります。 InitiateOAuth がREFRESH またはOFF のいずれかに設定されている場合、要求するスコープを変更したい場合は、このプロパティまたはScope 入力を使用する必要があります。

選択したOAuth フローのグラント種別を指定します。 この値は、OAuth カスタムアプリケーション作成時に設定されたグラント種別と同じである必要があります。

解説

ほとんどの場合、デフォルトのグラント種別は変更すべきではありません。 最も一般的なOAuth グラント種別とそれぞれのメリット・デメリットについては、https://oauth.net/2/grant-types/ を参照してください。

OAuth Client Id およびClient Secret を渡す方法を指定します。サポートされるオプション：BASIC およびPOST。

解説

OAuth RFC では、OAuthClientId とOAuthClientSecret を渡す2つの方法を提供します。 POST はpost データを介してOAuthClientId およびOAuthClientSecret を渡します。 （OAuthGrantType = PASSWORD, CODE, or CLIENT で動作します。） BASIC は、Authorize ヘッダーを介してOAuthClientId およびOAuthClientSecret を渡します。 （OAuthGrantType = CODE or CLIENT で動作します。）

アクセストークンリクエストにコールバックURL を含めるかどうか。

解説

デフォルトではtrue です。 標準に準拠したOAuth サービスでは、redirect_uri パラメータを必要としないCLIENT やPASSWORD などのグラント種別では、 redirect_uri パラメータを無視するからです。

このオプションは、redirect_uri が含まれる場合にエラーを報告するOAuth サービスに対してのみ有効にしてください。

OAuth サービスの認可URL。

解説

OAuth サービスの認可URL。このURL でユーザーはサーバーにログインしてアプリケーションにアクセス許可を与えます。OAuth 1.0 では、アクセス許可が付与されるとリクエストトークンが認可されます。

OAuth アクセストークンを取得するURL。

解説

OAuth アクセストークンを取得するURL。OAuth 1.0 では、このURL で認可されたリクエストトークンがアクセストークンと交換されます。

OAuth トークンをリフレッシュするURL。

解説

OAuth トークンをリフレッシュするURL。OAuth 2.0 では、古いトークンの期限が切れたときは、このURL でリフレッシュトークンと新しいアクセストークンと交換します。

サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。

解説

サービスがリクエストトークンを取得するために提供するURL。これは、OAuth 1.0 では必須です。OAuth 1.0 では、これがアプリケーションがリクエストトークンをリクエストするURL です。

OAuth アクセストークンをリクエストおよび取得するために使用される認証トークン。

解説

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthKey とともに指定して、OAuthAccessToken を取得できます。

OAuth アクセストークンをリクエストおよび取得するために使用される認証シークレット。

解説

このプロパティは、OAuth 1.0でヘッドレス認証を実行する場合にのみ必要です。これは、GetOAuthAuthorizationUrl ストアドプロシージャから取得できます。

GetOAuthAccessToken ストアドプロシージャでAuthToken とともに指定して、OAuthAccessToken を取得できます。

OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

解説

OAuth アクセストークンのリクエストでparamname=value の形式でサブミットするその他のパラメータのカンマ区切りのリスト。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

SSL クライアント認証（2-way SSL）のためのTLS/SSL クライアント証明書ストアを指定します。このプロパティは、他のSSL 関連プロパティと連動して、セキュアな接続を確立します。

解説

このプロパティは、SSL クライアント認証のためのクライアント証明書ストアを指定します。 このプロパティは、証明書ストアの種類を定義するSSLClientCertType、およびパスワードで保護されたストア用のパスワードを指定するSSLClientCertPassword と一緒に使用します。 SSLClientCert が設定され、SSLClientCertSubject が設定されている場合、ドライバーは指定されたサブジェクトに一致する証明書を検索します。

証明書ストアの指定はプラットフォームによって異なります。 Windowsでは、証明書ストアはMY（個人証明書）などの名前で識別されますが、Java では、証明書ストアは通常、証明書とオプションの秘密キーを含むファイルです。

Windows の共通のユーザとシステム証明書ストアの指定は以下のとおりです。

PFXFile タイプの場合、このプロパティをファイル名に設定します。PFXBlob タイプの場合は、このプロパティをPKCS12 形式のファイルのバイナリコンテンツに設定します。

SSL クライアント認証用のTLS/SSL クライアント証明書を格納するキーストアの種類を指定します。プラットフォームや証明書のソースに応じて、さまざまなキーストア形式から選択できます。

解説

このプロパティは、クライアント証明書を指定するために使用されるキーストアの形式と場所を決定します。 サポートされている値には、プラットフォーム固有およびユニバーサルなキーストア形式があります。 有効な値と使用方法は以下のとおりです。

TLS/SSL クライアント証明書ストアにアクセスするために必要なパスワードを指定します。選択した証明書ストアの種類がアクセスにパスワードを必要とする場合、このプロパティを使用します。

解説

このプロパティは、パスワードで保護された証明書ストアを開くために必要なパスワードを指定します。 このプロパティは、PFX やJKS タイプのストアによく推奨されるように、復号化のためにパスワードを必要とする証明書ストアを使用する場合に必要です。

証明書ストアの種類がパスワードを必要としない場合（Windows のUSER やMACHINE など）、このプロパティは空白のままにできます。 認証エラーを回避するため、パスワードが指定された証明書ストアに関連付けられたものと一致していることを確認してください。

TLS/SSL クライアント証明書のサブジェクトを指定し、証明書ストアで場所を検索します。 CN=www.server.com, C=US のように、識別名フィールドのカンマ区切りのリストを使用します。ワイルドカード * は、ストアの先頭の証明書を選択します。

解説

このプロパティは、サブジェクトに基づいてロードするクライアント証明書を決定します。Sync App は、指定されたサブジェクトに完全に一致する証明書を検索します。 完全に一致するものが見つからない場合、Sync App はサブジェクトの値を含む証明書を検索します。 一致する証明書がない場合、証明書は選択されません。

サブジェクトは、識別名フィールドと値のカンマ区切りリストという標準の形式に従うべきです。 例えば、CN=www.server.com, OU=Test, C=US です。一般的なフィールドには以下のものが含まれます。

Note： フィールドにカンマなどの特殊文字が含まれている場合は、値を引用符で囲む必要があります。例：CN="Example, Inc.", C=US。

FTP またはFTPS サーバーに接続する際の認証メカニズム。

解説

SSLMode がNONE に設定されている場合、サーバーへのログインには、デフォルトのプレーンテキストでの認証が使われます。 SSLMode がIMPLICIT に設定されている場合、接続が確立された直後にSSL ネゴシエーションが開始されます。 SSLMode がEXPLICIT に設定されている場合、Sync App は最初にプレーンテキストで接続し、次にSTARTTLS などのプロトコルコマンドを使用してSSL ネゴシエーションを明示的に開始します。 SSLMode がAUTOMATIC に設定されている場合、リモートポートがプロトコルの標準のプレーンテキストポート（適用可能な場所）に設定されている場合、コンポーネントはSSLMode がEXPLICIT に設定されている場合と同じように動作します。その他すべてのケースでは、SSL ネゴシエーションはIMPLICIT になります。

• AUTOMATIC
• NONE
• IMPLICIT
• EXPLICIT

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

解説

TLS/SSL 接続を使用する場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。コンピュータによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

このセクションでは、本プロバイダーの接続文字列で設定可能なSSH プロパティの全リストを提供します。

サービスへのSSH トンネルを確立する際に使用される認証方法。

解説

• None：認証は行われません。現在のSSHUser の値は無視され、接続は匿名でログインされます。
• Password：Sync App は、SSHUser とSSHPassword の値を使用してユーザーを認証します。
• Public_Key：Sync App は、SSHUser とSSHClientCert の値を使用してユーザーを認証します。SSHClientCert には、この認証方法を成功させるために使用可能な秘密鍵が必要です。

SSHUser の認証に使用する証明書。

解説

公開鍵認証を使用するには、SSHClientCert に有効な秘密鍵が含まれている必要があります。 公開鍵はオプションで、含まれていない場合はSync App が秘密鍵から生成します。 Sync App は公開鍵をサーバーに送信し、ユーザーが公開鍵を認証した場合に接続が許可されます。

SSHClientCertType フィールドは、SSHClientCert により指定されたキーストアの種類を指定します。 ストアがパスワードで保護されている場合は、SSHClientCertPassword でパスワードを指定します。

一部の種類のキーストアは、複数のキーを含むことができるコンテナです。 デフォルトでは、Sync App はストアの最初のキーを選択しますが、SSHClientCertSubject を使用して特定のキーを指定することも可能です。

SSHClientCert キーのパスワード（ある場合）。

解説

このプロパティは、証明書ベースの認証を使用する場合のSSH トンネリングに必要です。 SSH 証明書がパスワードで保護されたキーストアにある場合、証明書にアクセスするためにこのプロパティを使用してパスワードを指定します。

SSH クライアント証明書のサブジェクト。

解説

証明書のサブジェクトは、証明書をロードするときにストア内の証明書を検索するために使用されます。

完全に一致するものが見つからない場合、ストアはプロパティの値を含むサブジェクトを検索します。

それでも一致するものが見つからない場合、プロパティは空白で設定され、証明書は選択されません。

"*" に設定すると、証明書ストアの1番目の証明書が選択されます。

証明書のサブジェクトは識別の名前フィールドおよび値のカンマ区切りのリストです。 例えば、"CN=www.server.com, OU=test, C=US, [email protected]"。共通のフィールドとその説明は以下のとおりです。

フィールド値にカンマが含まれている場合は、それを引用符で囲む必要があります。

SSHClientCert 秘密鍵の種類。

解説

このプロパティには次の値の1つを設定できます。

SSH ユーザー。

解説

SSH ユーザー。

SSH パスワード。