> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# REST

CData Sync アプリケーションからREST コネクタを使用して、REST からデータを取得してサポートされている任意の同期先に移動できます。これを行うには、コネクタを追加し、コネクタへの認証を行い、接続を完了する必要があります。## REST コネクタを追加Sync でREST のデータを使用できるようにするには、まず以下の手順でコネクタを追加する必要があります：<ol>
  <li>Sync のダッシュボードから**接続**ページを開きます。</li>
  <li>**接続を追加**をクリックして**コネクタを選択**ページを開きます。</li>
  <li>**データソース**タブをクリックして
  **REST** 行に移動します。</li>

  <li>
    行末にある**接続を設定**アイコンをクリックして、**新しい接続**ページを開きます。この操作により、
    **接続を追加**ダイアログボックスが開きます。

    **Note：** **接続を設定**アイコンが表示されない場合は、**コネクタをダウンロード**アイコンをクリックして REST コネクタをインストールしてください。
  </li>

  <li>**接続を追加**ダイアログボックスに接続名を入力します。</li>
  <li>**追加**をクリックして、コネクタの**設定**タブを開きます。</li>
</ol>新しいコネクタのインストールについての詳細は、
[接続](https://docs.sync.cdata.com/26.4/ja/connections/connections.md)を参照してください。## REST への認証コネクタを追加したら、必要なプロパティを設定します。- **Api Key：** IBM Cloud に対してユーザーを識別するAPI キーを入力。
- **URI：** リソースの場所のURI（Uniform Resource Identifier）を入力。
- **Region：** S3 互換Web サービスのホスティングリージョンを入力。
- **Oracle Namespace：** 使用するOracle Cloud Object Storage ネームスペースを入力。
- **Azure Storage Account：** Azure ストレージアカウントの名前を入力。CData Sync は、いくつかの方法でREST への認証をサポートしています。以下から認証方法を選択し、認証の詳細を含む該当セクションに進みます。- [**Access Key**](#azure-access-key)
- [**AWS Credentials File**](#aws-credentials-file)
- [**Azure Active Directory**](#azure-active-directory)
- [**Azure Managed Service Identity**](#azure-managed-service-identity)
- [**Azure Service Principal**](#azure-service-principal)
- [**Azure Service Principal Certificate**](#azure-service-principal-certificate)
- [**Azure Shared Access Signature**](#azure-shared-access-signature)
- [**Basic**](#basic) (default)
- [**Digest**](#digest)
- [**GCP Instance Account**](#gcp-instance-account)
- [**IAM Secret Key**](#iam-secret-key)
- [**Negotiate**](#negotiate)
- [**None**](#none)
- [**OAuth**](#oauth)
- [**OAuth Client**](#oauth-client)
- [**OAuth JWT**](#oauth-jwt)
- [**OAuth Password**](#oauth-password)
- [**OAuth PKCE**](#oauth-pkce)
- [**Secure File Transfer Protocol**](#secure-file-transfer-protocol)### Azure Access KeyAzure のアクセスキーで接続するには、次のプロパティを設定します：<ul><li>\*\*Auth Scheme：\*\***Access Key** を選択。</li>
<li>\*\*Azure Access Key：\*\*ストレージアカウントに関連付けられているアクセスキーを入力。</li></ul>アクセスキーを取得するには：<ol><li>[Azure ポータル](https://portal.azure.com/)にルートアカウントの資格情報を使用してサインインします。</li>
<li>**ストレージ アカウント**をクリックして、使用するストレージアカウントを選択します。</li>
<li>**設定**の**アクセス キー**をクリックします。ページ上にストレージ アカウント名とキーが表示されます。</li></ol>### AWS Credentials File認証情報ファイルで接続するには、次のプロパティを指定します：- **Auth Scheme：** **AwsCredentialsFile** を選択。
- **AWS Credentials File：** Amazon Web Services（AWS）認証情報ファイルの場所を入力。
- （オプション）**AWS Credentials File Profile：** 指定した認証情報ファイルから使用するAWS プロファイルの名前を入力。プロファイル名を入力しない場合、Sync はdefault という名前のプロファイルを使用します。### Azure Active DirectoryAzure Active Directory（AD）ユーザーアカウントで接続するには、次のプロパティを指定します：- **Auth Scheme：** **AzureAD** を選択。
- **Use Lake Formation：** AWS Lake Formation サービスに一時的な認証情報を取得させる場合は、**Enable** チェックボックスをオンにします。この一時的な認証情報は、設定されたIAM ロールに基づいてユーザーにアクセスポリシーを適用します。このサービスは、Security Assertion Markup Language（SAML）アサーションを提供しながら、AzureAD、Okta、ADFS、PingFederate で認証する場合に使用できます。デフォルトでは、**Enable** チェックボックスはオフです。
- **OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。
- **OAuth Client Secret：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。### Azure Managed Service IdentityAzure 仮想マシン上でCData Sync が実行されている場合にAzure マネージドサービスID（MSI）を利用するには、**Auth Scheme** で**Azure MSI** を選択します。追加のプロパティは必要ありません。### Azure Service PrincipalAzure サービスプリンシパルとクライアントシークレットで接続するには、次のプロパティを設定します：- **Auth Scheme：** **AzureServicePrincipal** を選択。
- **Azure Tenant：** 接続するMicrosoft Online テナントを入力。
- **OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。
- **OAuth Client Secret：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。
- （オプション）**Scope：** アプリケーションへのアクセス範囲を指定。
- （オプション）**OAuth Authorization URL：** OAuth サービスのOAuth 認可URL を入力。
- （オプション）**OAuth Access Token URL：** アクセストークンを取得するURL を入力。
- （オプション）**OAuth Refresh Token URL：** OAuth トークンを更新するURL を入力。アプリケーションのOAuth クライアントId およびクライアントシークレットを取得するには：1) [Azure ポータル](https://portal.azure.com)にログインします。
2) 左ナビゲーションペインで**すべてのサービス**を選択します。次に**アプリの登録**を検索し選択します。
3) **新規登録**をクリックします。
4) アプリケーションの名前を入力して**任意のAzure AD ディレクトリ - マルチテナント**を選択します。
5) アプリケーションを作成したら、**概要**セクションに表示されるアプリケーション（クライアント）ID の値をコピーします。この値をOAuth クライアントId として使用します。
6) **証明書とシークレット**セクションに移動して、アプリケーションの**新しいクライアント シークレット**を選択します。
7) 有効期間を指定してクライアントシークレットを保存します。保存するとキーの値が表示されます。
8) 値は一度しか表示されないので、コピーしておきます。この値をOAuth クライアントシークレットとして使用します。
9) **認証**タブで、必ず**アクセストークン（暗黙的なフローに使用）** を選択します。### Azure Service Principal CertificateAzure サービスプリンシパルとクライアント証明書で接続するには、次のプロパティを設定します：- **Auth Scheme：** **AzureServicePrincipalCert** を選択。
- **Azure Tenant：** 接続するMicrosoft Online テナントを入力。
- **OAuth JWT Cert：** Java web token（JWT）証明書ストアを入力。
- **OAuth JWT Cert Type：** JWT 証明書を格納するキーストアの種類を入力。デフォルトの種類は**PEMKEY\_BLOB** です。
- （オプション）**OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。
- （オプション）**Scope：** アプリケーションへのアクセス範囲を指定。
- （オプション）**OAuth Authorization URL：** OAuth サービスのOAuth 認可URL を入力。
- （オプション）**OAuth Access Token URL：** アクセストークンを取得するURL を入力。
- （オプション）**OAuth Refresh Token URL：** OAuth トークンを更新するURL を入力。
- （オプション）**OAuth JWT Cert Password：** OAuth JWT 証明書のパスワードを入力。
- （オプション）**OAuth JWT Cert Subject：** OAuth JWT 証明書のサブジェクトを入力。アプリケーションのOAuth 証明書を取得するには：1) [Azure ポータル](https://portal.azure.com)にログインします。
2) 左ナビゲーションペインで**すべてのサービス**を選択します。次に**アプリの登録**を検索し選択します。
3) **新規登録**をクリックします。
4) アプリケーションの名前を入力して**任意のAzure AD ディレクトリ - マルチテナント**を選択します。
5) アプリケーションを作成したら、**概要**セクションに表示されるアプリケーション（クライアント）ID の値をコピーします。この値をOAuth クライアントId として使用します。
6) **証明書とシークレット**セクションに移動して、**証明書のアップロード**を選択します。次に、ローカルマシンからアップロードする証明書を選択します。
7) 有効期間を指定してクライアントシークレットを保存します。保存するとキーの値が表示されます。
8) 値は一度しか表示されないので、コピーしておきます。この値をOAuth クライアントシークレットとして使用します。
9) **認証**タブで、必ず**アクセストークン（暗黙的なフローに使用）** を選択します。### Azure Shared Access SignatureAzure の共有アクセス署名で接続するには、次のプロパティを設定します：<ul><li>\*\*Auth Scheme：\*\***SAS** を選択。</li>
<li>\*\*Azure Shared Access Signature：\*\*ストレージアカウントに関連付けられている共有アクセス署名を入力。</li></ul>Azure 共有アクセス署名を作成するには：<ol><li>[Azure ポータル](https://portal.azure.com)にルートアカウントの資格情報を使用してサインインします。</li>
<li>**ストレージ アカウント**をクリックして、使用するストレージアカウントを選択します。</li>
<li>**設定**の**Shared Access Signature** をクリックします。</li>
<li>アクセスポリシーとトークンの有効期限を設定します。</li>
<li>**SAS の生成**をクリックし、生成されたトークンをコピーします。</li></ol>### Basicユーザー資格情報で接続するには、次のプロパティを設定します：<ul><li>\*\*Auth Scheme：\*\***Basic** を選択。</li>
<li>\*\*User：\*\*REST アカウントへの認証に使用するユーザー名を入力。</li>
<li>\*\*Password：\*\*REST アカウントへの認証に使用するパスワードを入力。</li></ul>### Digestユーザー資格情報で接続するには、次のプロパティを設定します：<ul><li>\*\*Auth Scheme：\*\***Digest** を選択。</li>
<li>\*\*User：\*\*REST アカウントへの認証に使用するユーザー名を入力。</li>
<li>\*\*Password：\*\*REST アカウントへの認証に使用するパスワードを入力。</li></ul>### GCP Instance AccountGCP 仮想マシンでCData Sync を実行すると、Sync は仮想マシンに紐づけられたサービスアカウントを使用して認証できます。そのアカウントを使用するには、**Auth Scheme** で**GCPInstanceAccount** を選択します。追加のプロパティは必要ありません。### IAM Secret KeyIAM シークレットキーで接続するには、次のプロパティを設定します：- **Auth Scheme：** **IAMSecretKey** を選択。
- **Access Key：** アカウントのアクセスキーを入力。この値はセキュリティ認証情報ページから取得できます。
- **Secret Key：** アカウントのシークレットキーを入力。この値はセキュリティ認証情報ページから取得できます。### NegotiateKerberos 資格情報で接続するには、次のプロパティを指定します：- **Auth Scheme：** **Negotiate** を選択。
- **User：** REST への認証に使用するユーザー名を入力。
- **Password：** REST への認証に使用するパスワードを入力。
- **Kerberos KDC：** 認証に使用するKerberos キー配布センター（KDC）サービスを入力。
- **Kerberos Realm：** 認証に使用するKerberos レルムを入力。
- **Kerberos SPN：** Kerberos ドメインコントローラーのサービスプリンシパル名（SPN）を入力。
- （オプション）**Kerberos User：** Kerberos ドメインコントローラーのプリンシパル名を入力。名前はHost/User\@Realm の形式にする必要があります。
- （オプション）**Kerberos Keytab File：** Kerberos プリンシパルと暗号化キーのペアを含むキータブファイルのパスを入力。
- （オプション）**Kerberos Service Realm：** サービスのKerberos レルムを入力。
- （オプション）**Kerberos Service KDC：** 認証に使用するKerberos キー配布センター（KDC）サービスを入力。
- （オプション）**Kerberos Ticket Cache：** MIT Kerberos 資格情報キャッシュファイルの完全なパスを入力。Sync は、指定されたキャッシュファイルを使用して、Apache HBase への接続に必要なKerberos チケットを取得します。### OAuthOAuth カスタムクレデンシャルで接続するには、次のプロパティを指定します：- **Auth Scheme：** **OAuth** を選択。
- **OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。
- **OAuth Client Secret：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。
- （オプション）**Scope：** アプリケーションへのアクセス範囲を指定。
- （オプション）**OAuth Authorization URL：** OAuth サービスのOAuth 認可URL を入力。
- （オプション）**OAuth Access Token URL：** アクセストークンを取得するURL を入力。
- （オプション）**OAuth Refresh Token URL：** OAuth トークンを更新するURL を入力。### OAuth ClientOAuth クライアントで接続するには、次のプロパティを指定します：- **Auth Scheme：** **OAuthClient** を選択。
- **OAuth JWT Cert：** Java web token（JWT）証明書ストアを入力。
- **OAuth JWT Cert Type：** JWT 証明書を格納するキーストアの種類を入力。デフォルトの種類は**PEMKEY\_BLOB** です。
- **OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。
- **OAuth Client Secret：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。
- （オプション）**Scope：** アプリケーションへのアクセス範囲を指定。
- （オプション）**OAuth Authorization URL：** OAuth サービスのOAuth 認可URL を入力。
- （オプション）**OAuth Access Token URL：** アクセストークンを取得するURL を入力。
- （オプション）**OAuth Refresh Token URL：** OAuth トークンを更新するURL を入力。
- （オプション）**Subject Id：** アプリケーションが委任アクセスをリクエストしているユーザーサブジェクトを入力。
- **Subject Type：** クライアントクレデンシャル認証のサブジェクトの種類を選択。デフォルトの種類は**enterprise** です。### OAuth JWT
      

REST アカウントで接続するには、次のプロパティを指定します：


      \<ul><li>**Auth Scheme：****OAuthJWT** を選択。</li>
        \<li>**OAuth Client Id：**OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。</li>
        \<li>**OAuth Client Secret：**OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。</li>
        \<li>**Scope：**アプリケーションへのアクセス範囲を入力。</li>
        \<li>**OAuth JWT Cert：**Java web token（JWT）証明書ストアを入力。</li>
        \<li>**OAuth JWT Cert Type：**JWT 証明書を格納するキーストアの種類を入力。デフォルトの種類は**PEMKEY_BLOB** です。</li>
        \<li>**OAuth JWT Issuer：**Java web token の発行者を入力。通常、発行者はOAuth アプリケーションのクライアントId またはE メールアドレスです。</li>
        \<li>（オプション）**OAuth JWT Cert Subject：**OAuth JWT 証明書のサブジェクトを入力。</li>
        \<li>（オプション）**OAuth JWT Subject：**アプリケーションが委任されたアクセスを要求するユーザーサブジェクトを入力。</li>
        \<li>（オプション）**OAuth JWT Subject Type：**JWT 認証のサブジェクトの種類（**enterprise** または**user**）を選択。デフォルトの種類は**enterprise** です。</li>
        \<li>（オプション）**OAuth JWT Public Key Id：**JWT のパブリックキーのId を入力。</li></ul>
    - （オプション）**OAuth JWT Audience：** JWT を使用できるエンティティのスペース区切りリストを入力。
- （オプション）**OAuth JWT Validity Time：** JWT の有効期間を秒単位で指定。デフォルトは**3600** 秒です。上下の矢印をクリックして秒数を指定するか、テキストボックスに直接数値を入力します。### OAuth Passwordユーザー資格情報で接続するには、次のプロパティを指定します：<ul><li>\*\*Auth Scheme：\*\***OAuthPassword** を選択。</li>
<li>\*\*User：\*\*REST アカウントへの認証に使用するユーザー名を入力。</li>
<li>\*\*Password：\*\*REST アカウントへの認証に使用するパスワードを入力。</li>
<li>\*\*OAuth Client Id：\*\*OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。</li>
<li>\*\*OAuth Client Secret：\*\*OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。</li></ul>- **OAuth Version：** 使用するOAuth バージョンを選択。デフォルト値は最新バージョンです。
- （オプション）**Scope：** アプリケーションへのアクセス範囲を指定。
- （オプション）**OAuth Authorization URL：** OAuth サービスのOAuth 認可URL を入力。
- （オプション）**OAuth Access Token URL：** アクセストークンを取得するURL を入力。
- （オプション）**OAuth Refresh Token URL：** OAuth トークンを更新するURL を入力。### OAuth PKCEOAuth PKCE 拡張で接続するには、次のプロパティを設定します：- **Auth Scheme：** **OAuthPKCE** を選択。
- （オプション）**OAuth Client Id：** OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。### Secure File Transfer ProtocolSecure File Transfer Protocol（SFTP）で接続するには、次のプロパティを設定します：- **Auth Scheme：** **SFTP** を選択。
- **SSH Auth Mode：** サービスへのSSH トンネルを確立する際に使用する認証モードを選択。デフォルトのモードは**Password** です。
- **SSH User：** SSH ユーザーを入力。
- （オプション）**SSH Password：** SSH パスワードを入力。## 接続を完了する接続を完了するには：1) 次のプロパティを指定します：
   * **Format：** 接続先のREST ソースで使用されるデータ構造化標準を選択。デフォルトの標準は**JSON** です。
   * **Data Model：** 指定したフォーマットのドキュメントを解析し、データベースメタデータを生成するために使用するデータモデルを選択。デフォルトのデータモデルは**Document** です。
   * **JSON Format：** JSON ドキュメントのフォーマットを選択。デフォルト値は**JSON** です。
   * （オプション）**XPath：** XML ドキュメント内の同じ階層で繰り返されるXML パスを入力。複数のパスをセミコロン区切りのリストで指定できます。
   * **AWS Region：** Amazon Web Services をホストするリージョンを選択。デフォルトのリージョンは**NORTHERNVIRGINIA** です。
   * （オプション）**Storage Base URL：** クラウドストレージサービスプロバイダーのURL を入力。
2) **高度な設定** タブで詳細な接続設定を定義します。（ただし、ほとんどの場合、これらの設定は必要ありません。）
3) AzureAD で認証する場合は、**REST への接続**をクリックしてREST アカウントに接続します。
4) **作成およびテスト**をクリックして接続を作成します。## 詳細について


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.