> ## 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

export const CommonAuthSchemeOauthPassword = ({datasource = "the data source"}) => {
  return <>
      <p>ユーザー資格情報で接続するには、次のプロパティを指定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>OAuthPassword</strong> を選択。</li>
        <li><strong>User：</strong>{datasource} アカウントへの認証に使用するユーザー名を入力。</li>
        <li><strong>Password：</strong>{datasource} アカウントへの認証に使用するパスワードを入力。</li>
        <li><strong>OAuth Client Id：</strong>OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。</li>
        <li><strong>OAuth Client Secret：</strong>OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。</li>
      </ul>
    </>;
};

export const CommonAuthSchemeOauthJwt = ({datasource = "the data source"}) => {
  return <>
      <p>{datasource} アカウントで接続するには、次のプロパティを指定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>OAuthJWT</strong> を選択。</li>
        <li><strong>OAuth Client Id：</strong>OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントId を入力。</li>
        <li><strong>OAuth Client Secret：</strong>OAuth 認証サーバーにアプリケーションを登録した際に割り当てられたクライアントシークレットを入力。</li>
        <li><strong>Scope：</strong>アプリケーションへのアクセス範囲を入力。</li>
        <li><strong>OAuth JWT Cert：</strong>Java web token（JWT）証明書ストアを入力。</li>
        <li><strong>OAuth JWT Cert Type：</strong>JWT 証明書を格納するキーストアの種類を入力。デフォルトの種類は<strong>PEMKEY_BLOB</strong> です。</li>
        <li><strong>OAuth JWT Issuer：</strong>Java web token の発行者を入力。通常、発行者はOAuth アプリケーションのクライアントId またはE メールアドレスです。</li>
        <li>（オプション）<strong>OAuth JWT Cert Subject：</strong>OAuth JWT 証明書のサブジェクトを入力。</li>
        <li>（オプション）<strong>OAuth JWT Subject：</strong>アプリケーションが委任されたアクセスを要求するユーザーサブジェクトを入力。</li>
        <li>（オプション）<strong>OAuth JWT Subject Type：</strong>JWT 認証のサブジェクトの種類（<strong>enterprise</strong> または<strong>user</strong>）を選択。デフォルトの種類は<strong>enterprise</strong> です。</li>
        <li>（オプション）<strong>OAuth JWT Public Key Id：</strong>JWT のパブリックキーのId を入力。</li>
      </ul>
    </>;
};

export const CommonAuthSchemeGcpinstanceaccount = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>
        GCP 仮想マシンで{siteName} を実行すると、{siteNameShort} は仮想マシンに紐づけられたサービスアカウントを使用して認証できます。そのアカウントを使用するには、<strong>Auth Scheme</strong> で<strong>GCPInstanceAccount</strong> を選択します。追加のプロパティは必要ありません。
      </p>
    </>;
};

export const CommonAuthSchemeDigest = ({datasource = "the data source"}) => {
  return <>
      <p>ユーザー資格情報で接続するには、次のプロパティを設定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>Digest</strong> を選択。</li>
        <li><strong>User：</strong>{datasource} アカウントへの認証に使用するユーザー名を入力。</li>
        <li><strong>Password：</strong>{datasource} アカウントへの認証に使用するパスワードを入力。</li>
      </ul>
    </>;
};

export const CommonAuthSchemeBasic = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>ユーザー資格情報で接続するには、次のプロパティを設定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>Basic</strong> を選択。</li>
        <li><strong>User：</strong>{datasource} アカウントへの認証に使用するユーザー名を入力。</li>
        <li><strong>Password：</strong>{datasource} アカウントへの認証に使用するパスワードを入力。</li>
      </ul>
    </>;
};

export const CommonAuthSchemeSas = () => {
  return <>
      <p>Azure の共有アクセス署名で接続するには、次のプロパティを設定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>SAS</strong> を選択。</li>
        <li><strong>Azure Shared Access Signature：</strong>ストレージアカウントに関連付けられている共有アクセス署名を入力。</li>
      </ul>
      <p>Azure 共有アクセス署名を作成するには：</p>
      <ol>
        <li><a href="https://portal.azure.com" target="_blank" rel="noopener noreferrer">Azure ポータル</a>にルートアカウントの資格情報を使用してサインインします。</li>
        <li><strong>ストレージ アカウント</strong>をクリックして、使用するストレージアカウントを選択します。</li>
        <li><strong>設定</strong>の<strong>Shared Access Signature</strong> をクリックします。</li>
        <li>アクセスポリシーとトークンの有効期限を設定します。</li>
        <li><strong>SAS の生成</strong>をクリックし、生成されたトークンをコピーします。</li>
      </ol>
    </>;
};

export const CommonAuthSchemeAzuremsi = ({siteName = "CData Sync"}) => {
  return <>
      <p>
        Azure 仮想マシン上で{siteName} が実行されている場合にAzure マネージドサービスID（MSI）を利用するには、<strong>Auth Scheme</strong> で<strong>Azure MSI</strong> を選択します。追加のプロパティは必要ありません。
      </p>
    </>;
};

export const CommonAuthSchemeAccesskey = ({siteName = "CData Sync", siteNameShort = "Sync", datasource = "the data source"}) => {
  return <>
      <p>Azure のアクセスキーで接続するには、次のプロパティを設定します：</p>
      <ul>
        <li><strong>Auth Scheme：</strong><strong>Access Key</strong> を選択。</li>
        <li><strong>Azure Access Key：</strong>ストレージアカウントに関連付けられているアクセスキーを入力。</li>
      </ul>
      <p>アクセスキーを取得するには：</p>
      <ol>
        <li><a href="https://portal.azure.com/" target="_blank" rel="noopener noreferrer">Azure ポータル</a>にルートアカウントの資格情報を使用してサインインします。</li>
        <li><strong>ストレージ アカウント</strong>をクリックして、使用するストレージアカウントを選択します。</li>
        <li><strong>設定</strong>の<strong>アクセス キー</strong>をクリックします。ページ上にストレージ アカウント名とキーが表示されます。</li>
      </ol>
    </>;
};

export const CommonDatasourceMoreInformation = ({datasource = "the data source", advancedurl = "", siteName = "CData Sync", driverVersion = ""}) => {
  return <>
      <p>
        {siteName} と{datasource} の連携について、詳しくは{' '}
        <a href={`https://cdn.cdata.com/help/${advancedurl}${driverVersion}/jp/synch/default.htm`}>
          {datasource} Connector for {siteName}
        </a> を参照してください。
      </p>
    </>;
};

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        {siteNameShort} で{datasource} のデータを使用できるようにするには、まず以下の手順でコネクタを追加する必要があります：
      </p>
      <ol>
        <li>{siteNameShort} のダッシュボードから<strong>接続</strong>ページを開きます。</li>
        <li><strong>接続を追加</strong>をクリックして<strong>コネクタを選択</strong>ページを開きます。</li>
        <li>
          <strong>{destination ? "同期先" : "データソース"}</strong>タブをクリックして
          <strong>{title}</strong> 行に移動します。
        </li>
        <li>
          行末にある<strong>接続を設定</strong>アイコンをクリックして、<strong>新しい接続</strong>ページを開きます。この操作により、{' '}
          <strong>接続を追加</strong>ダイアログボックスが開きます。
          <br />
          <strong>Note：</strong> <strong>接続を設定</strong>アイコンが表示されない場合は、<strong>コネクタをダウンロード</strong>アイコンをクリックして {title} コネクタをインストールしてください。
        </li>
        <li><strong>接続を追加</strong>ダイアログボックスに接続名を入力します。</li>
        <li><strong>追加</strong>をクリックして、コネクタの<strong>設定</strong>タブを開きます。</li>
      </ol>
      <p>
        新しいコネクタのインストールについての詳細は、{' '}
        <a href="../connections">接続</a>を参照してください。
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      {siteName} アプリケーションから{datasource} コネクタを使用して、{datasource} からデータを取得してサポートされている任意の同期先に移動できます。これを行うには、コネクタを追加し、コネクタへの認証を行い、接続を完了する必要があります。
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "REST";
export const pageTitle = "REST";
export const advancedurl = "DW";
export const oauthschemes = "AzureAD";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## REST コネクタを追加

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## REST への認証

After you add the connector, you need to set the required properties.

* **Api Key:** Enter the API key that identifies the user to IBM Cloud.
* **URI:** Enter the Uniform Resource Identifier (URI) for your resource location.
* **Region:** Enter the hosting region for your S3-like web services.
* **Oracle Namespace:** Enter the Oracle Cloud Object Storage namespace to use.
* **Azure Storage Account:** Enter the name of your Azure storage account.

{siteName} supports authenticating to {pageTitle} in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

* [**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 Key

<CommonAuthSchemeAccesskey siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### AWS Credentials File

To connect with a credentials file, specify the following properties:

* **Auth Scheme:** Select **AwsCredentialsFile**.
* **AWS Credentials File:** Enter the location of your Amazon Web Services (AWS) credentials file.
* (Optional) **AWS Credentials File Profile:** Enter the name of the AWS profile that you want to use from the credentials file that you specify. If you do not enter a profile name, {siteNameShort} uses the profile named default.

### Azure Active Directory

To connect with an Azure Active Directory (AD) user account, specify the following properties:

* **Auth Scheme:** Select **AzureAD**.
* **Use Lake Formation:** Select the **Enable** checkbox if you want the AWS Lake Formation service to retrieve temporary credentials. These temporary credentials enforce access policies against the user based on the configured IAM role. You can use this service when you authenticate through AzureAD, Okta, ADFS, and PingFederate, while providing a Security Assertion Markup Language (SAML) assertion. By default, the **Enable** checkbox is not selected.
* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.

### Azure Managed Service Identity

<CommonAuthSchemeAzuremsi siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Azure Service Principal

To connect with an Azure service principal and client secret, set the following properties:

* **Auth Scheme:** Select **AzureServicePrincipal**.
* **Azure Tenant:** Enter the Microsoft Online tenant to which you want to connect.
* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
* (Optional) **Scope:** Specify the scope of your access to the application.
* (Optional) **OAuth Authorization URL:** Enter the OAuth authorization URL for the OAuth service.
* (Optional) **OAuth Access Token URL:** Enter the URL from which to retrieve the access token.
* (Optional) **OAuth Refresh Token URL:** Enter the URL from which to refresh the OAuth token.

To obtain the OAuth client Id and client secret for your application:

1. Log in to the <a href="https://portal.azure.com" target="_blank" rel="noopener noreferrer">Azure portal</a>.
2. In the left navigation pane, select **All services**. Then, search for and select **App registrations**.
3. Click **New registrations**.
4. Enter an application name and select **Any Azure AD Directory - Multi Tenant**.
5. After you create the application, copy the application (client) Id value that is displayed in the **Overview** section. Use this value as the OAuth client Id.
6. Navigate to the **Certificates & Secrets** section and select **New Client Secret** for the application.
7. Specify the duration and save the client secret. After you save it, the key value is displayed.
8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
9. On the **Authentication** tab, make sure to select **Access tokens (used for implicit flows)**.

### Azure Service Principal Certificate

To connect with an Azure service principal and client certificate, set the following properties:

* **Auth Scheme:** Select **AzureServicePrincipalCert**.
* **Azure Tenant:** Enter the Microsoft Online tenant to which you want to connect.
* **OAuth JWT Cert:** Enter your Java web tokens (JWT) certificate store.
* **OAuth JWT Cert Type:** Enter the type of key store that contains your JWT Certificate. The default type is **PEMKEY\_BLOB**.
* (Optional) **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* (Optional) **Scope:** Specify the scope of your access to the application.
* (Optional) **OAuth Authorization URL:** Enter the OAuth authorization URL for the OAuth service.
* (Optional) **OAuth Access Token URL:** Enter the URL from which to retrieve the access token.
* (Optional) **OAuth Refresh Token URL:** Enter the URL from which to refresh the OAuth token.
* (Optional) **OAuth JWT Cert Password:** Enter the password for your OAuth JWT certificate.
* (Optional) **OAuth JWT Cert Subject:** Enter the subject of your OAuth JWT certificate.

To obtain the OAuth certificate for your application:

1. Log in to the <a href="https://portal.azure.com" target="_blank" rel="noopener noreferrer">Azure portal</a>.
2. In the left navigation pane, select **All services**. Then, search for and select **App registrations**.
3. Click **New registrations**.
4. Enter an application name and select **Any Azure AD Directory - Multi Tenant**.
5. After you create the application, copy the application (client) Id value that is displayed in the **Overview** section. Use this value as the OAuth client Id.
6. Navigate to the **Certificates & Secrets** section and select **Upload certificate**. Then, select the certificate to upload from your local machine.
7. Specify the duration and save the client secret. After you save it, the key value is displayed.
8. Copy this value because it is displayed only once. You will use this value as the OAuth client secret.
9. On the **Authentication** tab, make sure to select **Access tokens (used for implicit flows)**.

### Azure Shared Access Signature

<CommonAuthSchemeSas siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Basic

<CommonAuthSchemeBasic siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### Digest

<CommonAuthSchemeDigest siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### GCP Instance Account

<CommonAuthSchemeGcpinstanceaccount siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

### IAM Secret Key

To connect with an IAM secret key, set the following properties:

* **Auth Scheme:** Select **IAMSecretKey**.
* **Access Key:** Enter your account access key. This value is available from your security credentials page.
* **Secret Key:** Enter your account secret key. This value is available from your security credentials page.

### Negotiate

To connect with Kerberos credentials, specify the following properties:

* **Auth Scheme:** Select **Negotiate**.
* **User:** Enter the username that you use to authenticate to {datasource}.
* **Password:** Enter the password that you use to authenticate to {datasource}.
* **Kerberos KDC:** Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.
* **Kerberos Realm:** Enter the Kerberos 5ealm that you use to authenticate.
* **Kerberos SPN:** Enter the service principal name (SPN) for the Kerberos domain controller.
* (Optional) **Kerberos User:** Enter the principal name for the Kerberos Domain Controller. The name should be in the form Host/User\@Realm.
* (Optional) **Kerberos Keytab File:** Enter the path to the keytab file that contains your pairs of the Kerberos principals and encrypted keys.
* (Optional) **Kerberos Service Realm:** Enter the Kerberos realm of the service.
* (Optional) **Kerberos Service KDC:** Enter the Kerberos Key Distribution Center (KDC) service that you use to authenticate.
* (Optional) **Kerberos Ticket Cache:** Enter the full path to an MIT Kerberos credential cache file. Sync uses the specified cache file to obtain the Kerberos ticket that is required to connect to Apache HBase.

### OAuth

To connect with OAuth custom credentials, specify the following properties:

* **Auth Scheme:** Select **OAuth**.
* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
* (Optional) **Scope:** Specify the scope of your access to the application.
* (Optional) **OAuth Authorization URL:** Enter the OAuth authorization URL for the OAuth service.
* (Optional) **OAuth Access Token URL:** Enter the URL from which to retrieve the access token.
* (Optional) **OAuth Refresh Token URL:** Enter the URL from which to refresh the OAuth token.

### OAuth Client

To connect with an OAuth client, specify the following properties:

* **Auth Scheme:** Select **OAuthClient**.
* **OAuth JWT Cert:** Enter your Java web tokens (JWT) certificate store.
* **OAuth JWT Cert Type:** Enter the type of key store that contains your JWT Certificate. The default type is **PEMKEY\_BLOB**.
* **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.
* **OAuth Client Secret:** Enter the client secret that you were assigned when you registered your application with an OAuth authorization server.
* (Optional) **Scope:** Enter the scope of your access to the application.
* (Optional) **OAuth Authorization URL:** Enter the OAuth authorization URL for the OAuth service.
* (Optional) **OAuth Access Token URL:** Enter the URL from which to retrieve the access token.
* (Optional) **OAuth Refresh Token URL:** Enter the URL from which to refresh the OAuth token.
* (Optional) **Subject Id:** Enter the user subject for which the application is requesting delegated access.
* **Subject Type:** Select the subject type for the client-credentials authentication. The default type is **enterprise**.

### OAuth JWT

<CommonAuthSchemeOauthJwt siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* (Optional) **OAuth JWT Audience:** Enter a space-separated list of entities that can use the JWT.
* (Optional) **OAuth JWT Validity Time:** Specify (in seconds) how long the JWT should remain valid. The default number of seconds is **3600**. Click the up and down arrows to specify the number of seconds, or enter the number directly in the text box.

### OAuth Password

<CommonAuthSchemeOauthPassword siteName={siteName} siteNameShort={siteNameShort} datasource={datasource} />

* **OAuth Version:** Select the OAuth version that you want to use. The default value is the latest version.
* (Optional) **Scope:** Enter the scope of your access to the application.
* (Optional) **OAuth Authorization URL:** Enter the OAuth authorization URL for the OAuth service.
* (Optional) **OAuth Access Token URL:** Enter the URL from which to retrieve the access token.
* (Optional) **OAuth Refresh Token URL:** Enter the URL from which to refresh the OAuth token.

### OAuth PKCE

To connect with the OAuth PKCE extension, set the following properties:

* **Auth Scheme:** Select **OAuthPKCE**.
* (Optional) **OAuth Client Id:** Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

### Secure File Transfer Protocol

To connect using Secure File Transfer Protocol, set the following properties:

* **Auth Scheme:** Select **SFTP**.
* **SSH Auth Mode:** Select the authentication mode to use when establishing an SSH tunnel to the service. The default mode is **Password**.
* **SSH User:** Enter the SSH user.
* (Optional) **SSH Password:** Enter the SSH password.

## 接続を完了する

To complete your connection:

1. Specify the following properties:
   * **Format:** Select the data structuring standard used by the REST source to which you want to connect. The default standard is **JSON**.
   * **Data Model:** Select the data model that you want to use to parse documents for your format and to generate the database metadata. The default data model is **Document**.
   * **JSON Format:** Select the format of the JSON document. The default value is **JSON**.
   * (Optional) **XPath:** Enter the XML path that repeats at the same level within the XML document. You can specify multiple paths in a semicolon-separated list.
   * **AWS Region:** Select the region that hosts your Amazon Web Services. The default region is **NORTHERNVIRGINIA**.
   * (Optional) **Storage Base URL:** Enter the URL of your cloud-storage service provider.
2. Define advanced connection settings on the **Advanced** tab. (In most cases, though, you should not need these settings.)
3. {oauthschemes ? `If you authenticate with ${oauthschemes}, click` : "Click"} **Connect to {datasource}** to connect to your {pageTitle} account.
4. Click **Create & Test** to create your connection.

## 詳細について

<CommonDatasourceMoreInformation datasource={datasource} advancedurl={advancedurl} siteName={siteName} driverVersion={driverVersion} />