Search

GraphQL

Version 24.3.9121

GraphQL

CData Sync アプリケーションからGraphQL コネクタを使用して、GraphQL からデータを取得してサポートされている任意の同期先に移動できます。これを行うには、コネクタを追加し、コネクタへの認証を行い、接続を完了する必要があります。

GraphQL コネクタを追加

Sync でGraphQL のデータを使用できるようにするには、まず以下の手順でコネクタを追加する必要があります。

  1. Sync のダッシュボードから接続ページを開きます。

  2. 接続を追加をクリックしてコネクタを選択ページを開きます。

  3. データソースタブをクリックしてGraphQL 行に移動します。

  4. 行末にある接続を設定アイコンをクリックして、新しい接続ページを開きます。接続を設定アイコンが利用できない場合は、コネクタをダウンロードアイコンをクリックしてGraphQL コネクタをインストールします。新規コネクタのインストールについて詳しくは、接続を参照してください。

GraphQL への認証

コネクタを追加したら、必須プロパティを設定する必要があります。

  • Connection Name - Enter a connection name of your choice.

  • URL - Enter the URL for your GraphQL service.

CData Sync supports authenticating to GraphQL in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

None

認証なしで接続するには、Auth Scheme でNone を選択します。追加のプロパティは必要ありません。

Basic

ユーザー資格情報で接続するには、次のプロパティを設定します。

  • Auth Scheme：Basic を選択。

  • User：GraphQL アカウントへの認証に使用するユーザー名を入力。

  • Password：GraphQL アカウントへの認証に使用するパスワードを入力。

OAuth

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

  • Auth Scheme – Select OAuth.

  • OAuth Version - Select the OAuth version that you want to use. The versions are Disabled (default), 1.0, and 2.0.

  • 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.

  • OAuth Authorization URL - Enter the OAuth authorization URL that you need to authorize request tokens when you sign in.

  • OAuth Access Token URL - Enter the URL from which the request for the access token is made.

  • OAuth Refresh Token URL - Enter the URL from which the refresh token is exchanged for a new access token when the old one expires. Note that for your data source, this URL might be the same as the access-token URL.

  • OAuth Request Token URL (optional) - Enter the URL from which the application requests the request token.

OAuth PKCE

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

  • Auth Scheme: Select OAuthPKCE.

  • OAuth Client Id - Enter the client Id that you were assigned when you registered your application with an OAuth authorization server.

  • OAuth Authorization URL - Enter the OAuth authorization URL that you need to authorize request tokens when you sign in.

  • OAuth Access Token URL - Enter the URL where the request for the access token is made.

  • OAuth Refresh Token URL - Enter the URL where the refresh token is exchanged for a new access token when the old one expires. Note that for your data source, this URL might be the same as the access-token URL.

AWS Cognito Secure Remote Password

To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:

  • Auth Scheme - Select AwsCognitoSrp.

  • User - Enter the username of the user that is registered in the user pool.

  • Password - Enter the password of the user that is registered in the user pool.

  • AWS Cognito Region - Select the region for your Amazon Web Services (AWS) user pool. The default region is NORTHERNVIRGINIA.

  • AWS User Pool Id - Enter your AWS user-pool identifier (Id).

  • AWS User Pool Client App Id - Enter your AWS user-pool client application Id.

  • AWS User Pool Client App Secret (optional) - Enter the secret for your user-pool client.

AWS Cognito Basic

To connect with your Amazon Web Services (AWS) Cognito credentials, specify the following properties:

  • Auth Scheme - Select AwsCognitoBasic.

  • User - Enter the username of the user that is registered in the user pool.

  • Password - Enter the password of the user that is registered in the user pool.

  • AWS Cognito Region - Select the region for your Amazon Web Services (AWS) user pool. The default region is NORTHERNVIRGINIA.

  • AWS User Pool Id - Enter your AWS user-pool identifier (Id).

  • AWS User Pool Client App Id - Enter your AWS user-pool client application Id.

  • AWS User Pool Client App Secret (optional) - Enter the secret for your user-pool client.

Complete Your Connection

To complete your connection:

  1. 高度な設定タブで接続の高度な設定を定義します。（ただし、ほとんどの場合これらの設定は必要ありません。）

  2. OAuth and OAuthPKCE で認証する場合は、GraphQL への接続 をクリックしてGraphQL アカウントに接続します。

  3. 作成およびテストをクリックして接続を作成します。

詳細情報

CData Sync とGraphQL の連携について、詳しくはGraphQL Connector for CData Sync を参照してください。