The Gmail connector is a Palantir-provided driver for Gmail.
To create a new Gmail source, follow the standard setup flow for Palantir-provided drivers, then use the sections below for Gmail-specific configuration and networking. For the complete property reference, see the official Gmail driver documentation ↗.
| Capability | Status |
|---|---|
| Exploration | 🟢 Generally available |
| Batch syncs | 🟢 Generally available |
| Incremental | 🟢 Generally available |
| OAuth 2.0 authentication | 🟢 Generally available |
| Table exports | 🟢 Generally available |
The properties below are mandatory or recommended.
| Property | Required? | Description | Default |
|---|---|---|---|
Schema ↗ | Mandatory | Used to specify what Gmail Api to use, either REST (default) or IMAP. | REST |
AuthScheme ↗ | Recommended | The type of authentication to use when connecting to Gmail. | OAuthJWT |
InitiateOAuth ↗ | Recommended | Specifies the process for obtaining or refreshing the OAuth access token, which maintains user access while an authenticated, authorized user is working. | GETANDREFRESH |
OAuthClientId ↗ | 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 ↗ | 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. | — |
OAuthJWTCert ↗ | Recommended | Supplies the name of the client certificate's JWT Certificate store. | — |
OAuthJWTCertType ↗ | Recommended | Identifies the type of key store containing the JWT Certificate. | GOOGLEJSONBLOB |
OAuthJWTSubject ↗ | Recommended | The user subject for which the application is requesting delegated access. | — |
The table below lists the domains that the source must be able to access to run.
For each domain, add a corresponding egress policy. If the source is hosted on-premises and not directly reachable from Foundry, use an agent proxy egress policy instead. The agent host itself must also be able to reach the listed domains. See using an agent as a proxy for details.
| Domain | Required |
|---|---|
| accounts.google.com | Always. Required for OAuth |
| googleapis.com | Always |
This connector supports OAuth 2.0 authentication. Follow the OAuth 2.0 guidance for Palantir-provided drivers to configure and authorize the connection.
This connector supports table exports. Learn how to set up a table export.