# SuiteCRM

<!-- BEGIN GENERATED:intro -->

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

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

<!-- END GENERATED:intro -->

<!-- BEGIN GENERATED:capabilities -->

:::callout{theme="neutral" title="Beta"}
The SuiteCRM connector is in the [beta](../../platform-overview/development-life-cycle/index.md) phase of development and may not be available on your enrollment. Functionality may change during active development.
:::

## Supported capabilities

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

<!-- END GENERATED:capabilities -->

<!-- BEGIN GENERATED:configuration -->

## Configuration

The properties below are mandatory or recommended.

| Property | Required? | Description | Default |
|---|---|---|---|
| [`Schema` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_p_Schema.htm) | Mandatory | The schema which will be used to connect to SuiteCRM. | `suitecrmv4` |
| [`URL` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_p_URL.htm) | Mandatory | The URL of the SuiteCRM account. | `https://{suiteCrmHost}.com/` |
| [`InitiateOAuth` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_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/ETK/jdbc/RSBSuiteCRM_p_OAuthClientId.htm) | Recommended | Specifies the client Id that was assigned when the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server. | — |
| [`OAuthClientSecret` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_p_OAuthClientSecret.htm) | Recommended | Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret). This secret registers the custom application with the OAuth authorization server. | — |
| [`Password` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_p_Password.htm) | Recommended | Specifies the password of the authenticating user account. | — |
| [`User` ↗](https://cdn.cdata.com/help/ETK/jdbc/RSBSuiteCRM_p_User.htm) | Recommended | Specifies the user ID of the authenticating SuiteCRM 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. URL connection property |

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