# GraphQL

<!-- BEGIN GENERATED:intro -->

The GraphQL connector is a [Palantir-provided driver](../../data-integration/foundry-provided-drivers/index.md) for GraphQL.

To create a new GraphQL source, follow the [standard setup flow for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#setup), then use the sections below for GraphQL-specific configuration and networking. For the complete property reference, see the [official GraphQL driver documentation ↗](https://cdn.cdata.com/help/LAK/jdbc/pg_connectionj.htm).

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

## Supported capabilities

| Capability | Status |
|---|---|
| Exploration | 🟢 Generally available |
| Batch syncs | 🟢 Generally available |
| Incremental | 🟢 Generally available |
| [OAuth 2.0 authentication](#oauth-20-authentication) | 🟢 Generally available |
| [Table exports](#table-exports) | 🟢 Generally available |

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`URL` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_URL.htm) | Mandatory | Specifies the endpoint URL of the GraphQL service. | `https://api.example.com/graphql` |
| [`AuthScheme` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_AuthScheme.htm) | Recommended | Specifies the authentication method to use when connecting to remote services. | `Basic` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_InitiateOAuth.htm) | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | `REFRESH` |
| [`OAuthClientId` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_OAuthClientId.htm) | Recommended | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_OAuthClientSecret.htm) | Recommended | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. | — |
| [`Password` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_Password.htm) | Recommended | Specifies the password of the authenticating user account. | — |
| [`User` ↗](https://cdn.cdata.com/help/LAK/jdbc/RSBGraphQL_p_User.htm) | Recommended | Specifies the user ID of the authenticating GraphQL user account. | — |

<!-- END GENERATED:configuration -->

<!-- BEGIN GENERATED:networking -->

## Networking

The table below lists the domains that the source must be able to access to run.

For each domain, add a corresponding [egress policy](../../administration/configure-egress/index.md). If the source is hosted on-premises and not directly reachable from Foundry, use an [agent proxy egress policy](../../administration/configure-egress/index.md#agent-proxy-egress-policies) instead. The agent host itself must also be able to reach the listed domains. See [using an agent as a proxy](../../data-connection/agent-proxy/index.md) for details.

| Domain  | Required |
|--- |--- |
| \<URL> | Always |
| \<OAuthRequestTokenURL> | If using `AuthScheme=OAuth` and `OAuthVersion=1.0` |
| \<OAuthAuthorizationURL> | If using `AuthScheme=OAuth` |
| \<OAuthAccessTokenURL> | If using `AuthScheme=OAuth` |
| \<OAuthRefreshTokenURL> | If using `AuthScheme=OAuth` and `OAuthVersion=2.0` |
| cognito-idp.\<AWSCognitoRegion>.amazonaws.\<TLD> | If `AuthScheme=AwsCognitoBasic,AwsCognitoSrp,`  AWSRegion Mappings |
| cognito-identity.\<AWSCognitoRegion>.amazonaws.\<TLD> | If `AuthScheme=AwsCognitoBasic,AwsCognitoSrp,`  AWSRegion Mappings |

<!-- END GENERATED:networking -->

<!-- BEGIN GENERATED:oauth -->

## OAuth 2.0 authentication

This connector supports OAuth 2.0 authentication. Follow the [OAuth 2.0 guidance for Palantir-provided drivers](../../data-integration/foundry-provided-drivers/index.md#oauth-20-authentication) to configure and authorize the connection.

<!-- END GENERATED:oauth -->

<!-- BEGIN GENERATED:table-exports -->

## Table exports

This connector supports table exports. Learn how to [set up a table export](../../data-connection/export-overview/index.md#table-exports).

<!-- END GENERATED:table-exports -->