Search

GraphQL

GraphQL

Setup Guide

Follow these steps to connect GraphQL to your CData Connect Cloud account:

  1. Open the Connections page of the CData Connect Cloud dashboard.

  2. Click + Add Connection in the upper-right corner.

  3. Type GraphQL into the search field, then click the data source name.

  4. On the Basic Settings tab of the new connection, enter a connection name or keep the default name.

  5. Enter the URL of your GraphQL service.

  6. If you do not need authentication, choose None in the Auth Scheme drop-down list. Otherwise, select the Authentication method, then proceed to the relevant section and follow those instructions.

Authentication Methods

Basic

  1. Enter the GraphQL username for authentication into User.

  2. Enter the user password.

  3. At the top of the CData Connect Cloud Add GraphQL Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuth

  1. Enter the OAuth Client Id assigned when you registered your GraphQL account for OAuth.

  2. Enter the OAuth Client Secret for your GraphQL account for OAuth.

  3. Enter the OAuth Authorization URL where the user logs into the service.

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

  5. Click Sign in to connect securely through OAuth. This action opens the GraphQL sign-in page in a new tab.

  6. Log in to your GraphQL account and provide the requested permissions (if applicable).

  7. At the top of the CData Connect Cloud Add GraphQL Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

OAuthPKCE

  1. Enter the OAuth Client Id assigned when you registered your GraphQL account for OAuth.

  2. Enter the OAuth Authorization URL where the user logs into the service.

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

  4. At the top of the CData Connect Cloud Add GraphQL Connection page, click Save & Test.

    • If the connection test succeeds, a Connection successfully saved message appears, indicating that your connection has been created. The Status on the Edit Connection page also changes to Authenticated. View the data model of your successful connection in the right pane of the Edit Connection page, in the Data Model tab.

    • If the connection test fails, ensure that you entered your login information correctly with no stray spaces or other characters. CData Connect Cloud displays error messages under the required fields with missing data. Some data sources require that you sign in directly to the source website. If you did not, an error message appears under the Sign in button. Correct the errors and try again.

    • Unsuccessful connections are saved as drafts and have a Status of Not Authenticated. You can return to the connection and authenticate it later.

More Information

For more information about interactions between CData Connect Cloud and GraphQL, see this information page.