Establishing a Connection

Adding a Connection to Google Directory

To add a connection to Google Directory:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Google Directory icon is not available, click the Add More icon to download and install the Google Directory connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Authenticating to Google Directory

The Sync App supports using user accounts and GCP instance accounts for authentication.

The following sections discuss the available authentication schemes for Google Directory:

User Accounts (OAuth)
Service Account (OAuthJWT)
GCP Instance Account

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Web Applications

When connecting via a Web application, you must create and register a custom OAuth application with Google Directory. You can then use the Sync App to acquire and manage the OAuth token values. See Creating a Custom OAuth Application for more information about custom applications.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call stored procedures to complete the OAuth exchange:

Call the GetOAuthAuthorizationURL stored procedure. Set the CallbackURL input to the Callback URL you specified in your application settings. The stored procedure returns the URL to the OAuth endpoint.
Navigate to the URL that the stored procedure returned in Step 1. Log in to the custom OAuth application and authorize the web application. Once authenticated, the browser redirects you to the callback URL.
Call the GetOAuthAccessToken stored procedure. Set AuthMode to WEB and the Verifier input to the "code" parameter in the query string of the callback URL.

Once you have obtained the access and refresh tokens, you can connect to data and refresh the OAuth access token either automatically or manually.

Automatic Refresh of the OAuth Access Token

To have the driver automatically refresh the OAuth access token, set the following on the first data connection:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.
OAuthAccessToken: Set this to the access token returned by GetOAuthAccessToken.
OAuthRefreshToken: Set this to the refresh token returned by GetOAuthAccessToken.
OAuthSettingsLocation: Set this to the location where the Sync App saves the OAuth token values, which persist across connections.

On subsequent data connections, the values for OAuthAccessToken and OAuthRefreshToken are taken from OAuthSettingsLocation.

Manual Refresh of the OAuth Access Token

The only value needed to manually refresh the OAuth access token when connecting to data is the OAuth refresh token.

Use the RefreshOAuthAccessToken stored procedure to manually refresh the OAuthAccessToken after the ExpiresIn parameter value returned by GetOAuthAccessToken has elapsed, then set the following connection properties:

OAuthClientId: Set this to the Client Id in your application settings.
OAuthClientSecret: Set this to the Client Secret in your application settings.

Then call RefreshOAuthAccessToken with OAuthRefreshToken set to the OAuth refresh token returned by GetOAuthAccessToken. After the new tokens have been retrieved, open a new connection by setting the OAuthAccessToken property to the value returned by RefreshOAuthAccessToken.

Finally, store the OAuth refresh token so that you can use it to manually refresh the OAuth access token after it has expired.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you must authenticate on another device that has an internet browser.

Choose one of two options:
- Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
- Option 2: Install the Sync App on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

Choose one of these options:
- If you are using the Embedded OAuth Application click Google Directory OAuth endpoint to open the endpoint in your browser.
- If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
  - InitiateOAuth: Set to OFF.
  - OAuthClientId: Set to the client Id assigned when you registered your application.
  - OAuthClientSecret: Set to the client secret assigned when you registered your application.
  Then call the GetOAuthAuthorizationURL stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

InitiateOAuth: Set this to REFRESH.
OAuthVerifier: Set this to the verifier code.
OAuthClientId: (custom applications only) Set this to the Client Id in your custom OAuth application settings.
OAuthClientSecret: (custom applications only) Set this to the Client Secret in the custom OAuth application settings.
OAuthSettingsLocation: Set this to persist the encrypted OAuth authentication values to the specified location.

After the OAuth settings file is generated, re-set the following properties to connect:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you must create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties to connect to data:

InitiateOAuth: Set this to REFRESH.
OAuthClientId: (custom applications only) Set this to the client Id assigned when you registered your application.
OAuthClientSecret: (custom applications only) Set this to the client secret assigned when you registered your application.
OAuthSettingsLocation: Set this to the location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

GCP Instance Accounts

When running on a GCP virtual machine, the Sync App can authenticate using a service account tied to the virtual machine. To use this mode, set AuthScheme to GCPInstanceAccount.

Advanced Features

This section details a selection of advanced features of the Google Directory Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Google Directory and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The CData Sync App models Google Directory APIs as relational tables, views, and stored procedures. API limitations and requirements for the available objects are documented in this section.

Tables

The Sync App provider models the Google Directory API as relational Tables.

Views

Views offer additional information from Google Directory.

Stored Procedures

Stored Procedures are function-like interfaces to the data source.

Tables

The Sync App models the data in Google Directory as a list of tables in a relational database that can be queried using standard SQL statements.

Google Directory Connector for CData Sync Tables


Name	Description
ChromeOsDevices	Retrieve all Chrome devices for an account.
DomainAliases	Create, update, and query aliases of a domain.
Domains	Create, delete, and query the domains for a user.
GroupAliases	Create, delete, and query aliases for a group.
GroupMembers	Create, update, delete, and query the members for a group.
Groups	Create, update, delete, and query groups.
Notifications	Update, delete, and query notifications for a customer.
OrganizationUnits	Create, update, delete, and query the organization units for a customer.
RoleAssignments	Create, delete, and query roles assigned to users.
Tokens	Query and delete tokens for a user.
UserAliases	Lists aliases, which are alternative email addresses for a user.
Users	Query user information.

ChromeOsDevices

Retrieve all Chrome devices for an account.

Table Specific Information

Select

To get a list of all Chrome devices for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM ChromeOsDevices

INSERT

INSERTs are not supported for this table.

Update

Updates a device's annotatedUser, annotatedLocation, or notes properties. To update a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.

UPDATE ChromeOsDevices SET AnnotatedUser = 'User_2' WHERE Id = '12345' AND CustomerId = '1234'.

Delete

Deletes are not supported for this table.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique ID of the Chrome device.
SerialNumber	String	True	The Chrome device serial number entered when the device was enabled. This value is the same as the Admin console's Serial Number in the Chrome OS Devices tab.
Model	String	True	The device's model information. If the device does not have this information, this property is not included in the response.
MEID	String	True	The Mobile Equipment Identifier (MEID) for the 3G mobile card in a mobile device. A MEID is typically used when adding a device to a wireless carrier's post-pay service plan. If the device does not have this information, this property is not included in the response.
LastSync	Datetime	True	The date and time the device was last enrolled.
AnnotatedUser	String	False	The user of the device as noted by the administrator. Maximum length is 100 characters. Empty values are allowed.
AnnotatedLocation	String	False	The address or location of the device as noted by the administrator. Maximum length is 200 characters. Empty values are allowed.
AnnotatedAssetId	String	False	The asset identifier as noted by an administrator or specified during enrollment.
Notes	String	False	Notes about this device added by the administrator. This property can be searched with the list method's query parameter. Maximum length is 500 characters. Empty values are allowed.
OrgUnitPath	String	False	The full parent path with the organizational unit's name associated with the device. Path names are case insensitive. If the parent organizational unit is the top-level organization, it is represented as a forward slash, /. This property can be updated using the API
OrderNumber	String	True	The device's order number. Only devices directly purchased from Google have an order number.
MacAddress	String	True	The device's wireless MAC address. If the device does not have this information, it is not included in the response.
WillAutoRenew	Boolean	True	Determines if the device will auto renew its support after the support end date. This is a read-only property.
OsVersion	String	True	The Chrome device's operating system version.
PlatformVersion	String	True	The Chrome device's platform version.
FirmwareVersion	String	True	The Chrome device's firmware version.
BootMode	String	True	The boot mode for the device.
LastEnrollmentTime	String	True	The date and time the device was last enrolled.
TmpVersionInfoAggr	String	True	Trusted Platform Module (TPM).
ActiveTimeRangesAggr	String	True	List of active time ranges.
RecentUsersAggr	String	True	List of recent device users, in descending order, by last login time.
DeviceFilesAggr	String	True	List of device files to download.
ETag	String	True	ETag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

DomainAliases

Create, update, and query aliases of a domain.

Table Specific Information

Select

To get a list of all the aliases for a domain, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM DomainAliases

Insert

To insert an alias, the following columns are required: CustomerId, ParentDomain, and DomainAliasName.

INSERT INTO DomainAliases (CustomerId, DomainAliasName, ParentDomain) VALUES ('12345', 'Alias', 'parentdomain.com')

Update

UPDATEs are not supported for this table.

Delete

To delete an alias, the following columns are required: CustomerId and DomainAliasName.

DELETE FROM DomainAliases WHERE CustomerId = 'C020vaw0q' AND DomainAliasName = 'Alias'

Columns


Name	Type	ReadOnly	Description
DomainAliasName [KEY]	String	False	The domain alias name.
ParentDomain	String	False	The parent domain name that the domain alias is associated with.
IsVerified	Boolean	True	Indicates the verification state of a domain alias.
CreationDate	Timestamp	True	Creation date timestamp of the domain alias in milliseconds.
ETag	String	True	ETag of the resource

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

Domains

Create, delete, and query the domains for a user.

Table Specific Information

Select

To get a list of all the domains, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used, as in the following query.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Domains

Insert

To insert a domain, the following columns are required: CustomerId and DomainName.

INSERT INTO Domains (CustomerId, DomainName) VALUES ('12345', 'exampledomain.com')

Update

UPDATEs are not supported for this table.

Delete

To delete a domain, the DomainName column is required.

DELETE FROM Domains WHERE DomainName = 'exampledomain.com'

Columns


Name	Type	ReadOnly	Description
DomainName [KEY]	String	False	The domain name.
IsPrimary	Boolean	True	Indicates if the domain is a primary domain.
IsVerified	Boolean	True	Indicates the verification state of a domain.
CreationDate	Datetime	True	The creation date of the domain.
Aliases	String	True	The aliases of the domain.
ETag	String	True	ETag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

GroupAliases

Create, delete, and query aliases for a group.

Table Specific Information

Select

To get a list of all the aliases for a group, the GroupId column is required. If not specified, the GroupId of the first group from the Groups table will be used.

The following query shows the only filter processed server side by the Google Directory API:

SELECT * FROM GroupAliases WHERE GroupId = '12345'

Insert

To insert an alias, the following columns are required: GroupId and Alias.

INSERT INTO GroupAliases (GroupId, Alias) VALUES ('12345', 'Alias')

Update

UPDATEs are not supported for this table.

Delete

To delete an alias, the following columns are required: GroupId and Alias.

DELETE FROM GroupAliases WHERE GroupId = '12345' AND Alias = 'Alias'

Columns


Name	Type	ReadOnly	Description
Alias [KEY]	String	False	The alias email address.
GroupId	String	True	Id of the group.
PrimaryEmail	String	True	PrimaryEmail of the group.
ETag	String	True	ETag of the resource.

GroupMembers

Create, update, delete, and query the members for a group.

Table Specific Information

Select

To get a list of all the members of a group, the GroupId column is required. If not specified, the Id of the first group from the Groups table will be used.

The following query shows the only filter processed server side by the Google Directory API:

SELECT * FROM GroupMembers WHERE GroupId = '12345'

Insert

To insert a member, the following columns are required: Email and GroupId. The Role column only accepts the following values: MEMBER, MANAGER, and OWNER.

INSERT INTO GroupMembers (Email, GroupId, Role) VALUES ('[email protected]', '12345', 'MEMBER')

Update

To update a member, the following columns are required: GroupId and Id.

UPDATE GroupMembers SET Role = 'MEMBER' WHERE GroupId = '1234' AND Id = '12345'

Delete

To delete a member, the following columns are required: GroupId and Id.

DELETE FROM GroupMembers WHERE GroupId = '1234' AND Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The unique identifier for the member.
GroupId	String	True	The unique identifier for the member.
Email	String	False	The email of the member.
Role	String	False	The name of the member.
Status	String	True	The status of the member.
Type	String	True	The type of members.
ETag	String	True	ETag of the resource

Groups

Create, update, delete, and query groups.

Table Specific Information

Select

To get a list of all the groups, the CustomerId is required. You can either set it in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory API:

SELECT * FROM Groups

Insert

To insert a group, the Email column is required.

INSERT INTO Groups (Email, Name, Description) VALUES ('[email protected]', 'Group Example Name', 'Example Description')

Update

To update a group, the Id is required.

UPDATE Groups SET Email = '[email protected]', Name = 'Group', Description = 'Description' WHERE Id = 1231

Delete

To delete a group, the Id column is required.

DELETE FROM Groups WHERE Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier for the group.
Email	String	False	The email of the group.
Name	String	False	The name of the group.
MembersCount	Long	True	The number of members.
Description	String	False	Description of the group.
Aliases	String	True	Aliases of the group.
AdminCreated	Boolean	True	Indicates if the group was created by an admin.
ETag	String	True	ETag of the resource

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	The customer Id of the group.
Domain	String	Domain name.

Notifications

Update, delete, and query notifications for a customer.

Table Specific Information

Select

To get a list of all the notifications, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Notifications

INSERT

INSERTs are not supported for this table.

Update

To update a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.

UPDATE Notifications SET IsUnread = true WHERE Id = '12345' AND CustomerId = '1234'.

Delete

To delete a notification, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.

DELETE FROM Notifications WHERE CustomerId = '1234' AND Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of the notification
Subject	String	False	Subject of the notification
Body	String	True	The body of the notification
SendDate	Datetime	True	The date when the notification was sent
FromAddress	String	True	The address from which the notification is recieved
IsUnread	Boolean	False	Indicates wether the notification is unread or not
ETag	String	True	ETag of the resource

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

OrganizationUnits

Create, update, delete, and query the organization units for a customer.

Table Specific Information

Select

To get a list of all the organization units, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM OrganizationUnits

Insert

To insert an organization unit, the following columns are required: CustomerId, Name, and ParentOrgUnitId. If not specified, the CustomerId of the current account will be used.

INSERT INTO OrganizationUnits (CustomerId, Name, Description, OrgUnitPath, ParentOrgUnitId, ParentOrgUnitPath) VALUES ('12345', 'OrgUnit Name', 'OrgUnit Description', 'Path', '123456', 'ParentPath', '1234')

Update

To update an organization unit, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.

UPDATE OrganizationUnits SET Name = 'OrgUnit Name', 'Description = 'OrgUnit Description', OrgUnitPath = 'Path', ParentOrgUnitId = '123456', ParentOrgUnitPath = 'ParentPath' WHERE CustomerId = '1234' AND Id = '12345'

Delete

To delete an organization unit, the following columns are required: CustomerId and Id. If not specified, the CustomerId of the current account will be used.

DELETE FROM OrganizationUnits  WHERE CustomerId = '1234' AND Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	Id of the Organization Unit.
Name	String	False	Name of the Organization Unit.
Description	String	False	Description of the Organization Unit.
OrgUnitPath	String	False	Path of the OrgOrganization Unit.Unit
ParentOrgUnitPath	String	False	Path of the Organization Unit's parent.
ParentOrgUnitId	String	False	Id of the Organization Unit's parent
ETag	String	True	ETag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

RoleAssignments

Create, delete, and query roles assigned to users.

Table Specific Information

Select

To get a list of all the roles assigned to users, the CustomerId column is required. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM RoleAssignments

Insert

To assign a role to a user, the following columns are required: RoleId, UserId, ScopeType, and CustomerId. If not specified, the CustomerId of the current account will be used. ScopeType has only two acceptable values : CUSTOMER and ORG_UNIT.

INSERT INTO RoleAssignments (RoleId, UserId, ScopeType) VALUES ('12345', '123456', 'CUSTOMER')

Update

UPDATEs are not supported for this table.

Delete

To remove an assigned role from a user, the Id and CustomerId columns are required. If not specified, the CustomerId of the current account will be used.

DELETE FROM RoleAssignments WHERE Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier of the role assignment.
RoleId	String	False	The Id of the role that is assigned.
UserId	String	False	The Id of the user this role is assigned to.
OrgUnitId	String	False	If the role is restricted to an organizational unit, this contains the ID for the organizational unit the exercise of this role is restricted to.
ScopeType	String	False	The scope in which this role is assigned. Acceptable values are 'CUSTOMER' and 'ORG_UNIT'.
Etag	String	True	Etag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

Tokens

Query and delete tokens for a user.

Table Specific Information

Select

To get a current set of tokens a specified user has issued to 3rd party applications, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Tokens

INSERT

INSERTs are not supported for this table.

Update

UPDATEs are not supported for this table.

Delete

To delete a token, the UserId and Id columns are required.

DELETE FROM Tokens WHERE UserId = '12345' AND Id = '123456'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Client ID of the application the token is issued to.
UserId	String	False	Aggregate of child privileges.
DisplayText	String	False	The displayable name of the application the token is issued to.
IsAnonymous	Boolean	False	Indicates if the name of the privilege.
IsNativeApp	Boolean	False	Indicates if the token is issued to an installed application.
ScopesAggregate	String	False	Aggregate of child privileges.
Etag	String	False	Etag of the resource.

UserAliases

Lists aliases, which are alternative email addresses for a user.

Table Specific Information

Select

To get a list of all the aliases for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Aliases

Insert

To insert an alias, the following columns are required: UserId and Alias.

INSERT INTO Aliases (UserId, Alias) VALUES ('12345', 'Alias')

Update

UPDATEs are not supported for this table.

Delete

To delete an alias, the following columns are required: UserId and Alias.

DELETE FROM Aliases WHERE Id = '12345' AND Alias = 'Alias'

Columns


Name	Type	ReadOnly	Description
Alias [KEY]	String	False	The alias email address.
UserId	String	True	Id of the user.
PrimaryEmail	String	True	PrimaryEmail of the user.
ETag	String	True	ETag of the resource.

Users

Query user information.

Table Specific Information

Select

To get a list of all the users, CustomerId is required. You can either set it in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Users

Insert

To insert a user, the following columns are required: PrimaryEmail, FirstName, Surname, and Password.

INSERT INTO Users (PrimaryEmail, FirstName, Surname, Password, Suspended) VALUES ('[email protected]', 'John', 'Doe', '12345', true)

Update

To update a user, the Id column is required.

UPDATE Users SET PrimaryEmail = '[email protected]', FirstName = 'John', Surname = 'Doe', Suspended = true WHERE Id = 1231

Delete

To delete users, the Id column is required.

DELETE FROM Users WHERE Id = '12345'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The unique identifier for the user.
CustomerId	String	True	The customer Id of the user.
PrimaryEmail	String	False	The primary email of the user.
FirstName	String	False	The first name of the user.
Surname	String	False	The surname of the user.
Aliases	String	True	The aliases of the user.
IsAdmin	Boolean	True	Indicates if the user is an admin.
IsDelegatedAdmin	Boolean	True	Indicates if the user is a delegated admin.
LastLoginDate	Datetime	True	Last time the user logged on.
CreationDate	Datetime	True	Creation date of the user.
DeletionDate	Datetime	True	Deletion date of the user.
AgreedToTerms	Boolean	True	Indicates if the user agreed to the terms or not.
Suspended	Boolean	False	Indicates if the user got supsended.
SuspensionReason	String	True	The reason the user got supsended.
OrgUnitPath	String	False	The full path of the parent organization associated with the user. If the parent organization is the top-level, it is represented as a forward slash (/).
IsMailBoxSetup	Boolean	True	Indicates if the user's Google mailbox is created. This property is only applicable if the user has been assigned a Gmail license.
IsEnrolledIn2Sv	Boolean	True	Indicates if the user is enrolled in 2-step verification.
IsEnforcedIn2Sv	Boolean	True	Indicates if the user is enforced in 2-step verification.
IncludeInGlobalAddressList	Boolean	True	Indicates if the user's profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain.
ThumbnailPhotoUrl	String	True	Photo Url of the user

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Password	String	The password of the user.
Domain	String	Domain name

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Google Directory Connector for CData Sync Views


Name	Description
AppSpecificPasswords	Lists all Application Specific Passwords (passwords that are used with applications that do not accept verification codes) issued by a user.
MobileDevices	Lists mobile devices for an account.
Privileges	Lists all Privileges.
Roles	Lists roles in a domain.
UserAddresses	Lists the addresses for a user.
UserEmails	Query the emails for a user.
UserInstantMessagingAccounts	Query the IM accounts for a user.
UserLocations	Query the locations for a user.
UserOrganizations	Query the organizations for a user.
UserPhones	Query the phone numbers for a user.
UserWebsites	Retrieve a list of the websites of a user.
VerificationCodes	Query verification codes for a user.

AppSpecificPasswords

Lists all Application Specific Passwords (passwords that are used with applications that do not accept verification codes) issued by a user.

Table Specific Information

Select

To get a list of all the application specific tokens issued by a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.

For example, the following query is processed server side by the Google Directory API:

SELECT * FROM AppSpecificPasswords

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier of the ASP.
UserId	String	The unique identifier of the user who issued the ASP.
Name	String	Name of the ASP.
CreationDate	Datetime	The date when the ASP was created.
LastTimeUsed	Datetime	The time when the ASP was last used.
Etag	String	Etag of the resource.

MobileDevices

Lists mobile devices for an account.

Table Specific Information

Select

To get a list of all mobile devices for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM MobileDevices

Columns


Name	Type	Description
Id [KEY]	String	The serial number for a Google Sync mobile device. For Android and iOS devices, this is a software generated unique identifier.
ResourceId	String	The unique ID the API service uses to identify the mobile device.
Name	String	List of the owner's usernames.
AccountsList	String	List of accounts added on device.
Email	String	List of the owner's emails.
Model	String	The mobile device's model name.
OS	String	The mobile device's operating system
Type	String	The type of mobile device.
Status	String	The device's status.
HardwareId	String	The IMEI/MEID unique identifier for Android hardware.
FirstSyncDate	Datetime	The date and time the device was initially synchronized with the policy settings in the Admin console.
LastSyncDate	Datetime	The date and time the device was last synchronized with the policy settings in the Admin console.
UserAgent	String	Gives information about the device such as os version.
SerialNumber	String	The device's serial number.
IMEI	String	The device's IMEI number.
MEID	String	The device's MEID number.
WiFiMacAddress	String	The device's MAC address on Wi-Fi networks.
NetworkOperator	String	Mobile Device mobile or network operator.
DefaultLanguage	String	The default langauge used on the device.
DeviceCompromisedStatus	String	The compromised device status.
BuildNumber	String	The device's operating system build number.
KernelVersion	String	The device's kernel version.
BasebandVersion	String	The device's baseband version.
Manufacturer	String	The device's manufacturer.
ReleaseVersion	String	Mobile Device release version version.
SecurityPatchLevel	String	The device's security patch level.
Brand	String	The device's brand.
BootloaderVersion	String	The device's bootloader version.
Hardware	String	The device's hardware.
EncryptionStatus	String	The device's encryption status.
DevicePasswordStatus	String	The device's password status
Privilege	String	DMAgentPermission.
UnknownSourcesStatus	Boolean	Indicates if unknown sources are enabled or disabled on device
AdbStatus	Boolean	Indicates if adb(USB debugging) is enabled or disabled on device
IsOnOwnerProfile	Boolean	Indicates if this account is on owner/primary profile or not.
SupportsWorkProfile	Boolean	Indicates if work profile is supported on device.
Etag	String	Etag of the resource

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	The Id of the customer

Privileges

Lists all Privileges.

Table Specific Information

Select

To get a list of all privileges for an account, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Privileges

Columns


Name	Type	Description
ServiceId [KEY]	String	The obfuscated ID of the service this privilege is for.
ServiceName [KEY]	String	The name of the service this privilege is for.
PrivilegeName	String	The name of the privilege.
ParentServiceId	String	The service Id of the parent privilege.
ParentPrivilegeName	String	The privilege name of the parent privilege.
IsOrganizationUnitRestrictable	Boolean	Indicates if the privilege can be restricted to an organization unit.
Etag	String	Etag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

Roles

Lists roles in a domain.

Table Specific Information

Select

To get a list of all the roles, the CustomerId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the CustomerId of the current account will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM Roles

Columns


Name	Type	Description
Id [KEY]	String	The unique identifier for the role.
Name	String	Name of the role.
Description	String	A short description of the role.
PrivilegeName	String	The name of the privilege.
ServiceId	String	The ID of the service the privilege is for.
IsSystemRole	Boolean	Indicates if it is a pre-defined system role.
IsSuperAdminRole	Boolean	Indicates if the role is a super admin role.
Etag	String	Etag of the resource.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
CustomerId	String	Id of the customer

UserAddresses

Lists the addresses for a user.

Table Specific Information

Select

To get a list of addresses for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the UserId of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserAddresses

Columns


Name	Type	Description
UserId	String	The unique identifier for the user.
Type	String	The address type.
CustomType	String	The custom type of the address.
FormattedAddress	String	The full unstructured postal address.
PoBox	String	Post office box of the address.
ExtendedAddress	String	The extended address
StreetAddress	String	The street address
Locality	String	The town or city of the address.
Region	String	The abbreviated province or state.
PostalCode	String	The ZIP or postal code, if applicable.
Country	String	Country in the address.
CountryCode	String	The country code. Uses the ISO 3166-1 standard.
IsPrimary	Boolean	Indicates if this is the primary address of the user

UserEmails

Query the emails for a user.

Table Specific Information

Select

To get a list of email addresses for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserEmails

Columns


Name	Type	Description
Address	String	The user's email address
UserId	String	The unique identifier for the user.
IsPrimary	String	Indicates if this is the user's primary email.
CustomType	String	The custom type of the email.
Type	String	The type of the email account.

UserInstantMessagingAccounts

Query the IM accounts for a user.

Table Specific Information

Select

To get a list of IM accounts for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserInstantMessagingAccounts

Columns


Name	Type	Description
IM	String	The user's IM network ID.
UserId	String	The unique identifier for the user.
Protocol	String	The IM protocol identifies the IM network.
CustomProtocol	String	The custom type of the IM protcol.
IsPrimary	String	Indicates if this is the user's primary IM.
CustomType	String	The custom type of the IM account.
Type	String	The type of the IM account.

UserLocations

Query the locations for a user.

Table Specific Information

Select

To get a list of locations for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserLocations

Columns


Name	Type	Description
Area	String	Textual location of the user.
UserId	String	The unique identifier for the user.
BuildingId	String	The building identifier.
DeskCode	String	The desk location.
FloorName	String	The floor name/number
FloorSection	String	The floor section.
CustomType	String	The custom type of the location.
Type	String	The type of the location.

UserOrganizations

Query the organizations for a user.

Table Specific Information

Select

To get a list of organizations for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserOrganizations

Columns


Name	Type	Description
Name	String	The name of the organization.
UserId	String	The unique identifier for the user.
OrganizationDomain	String	The domain the organization belongs to.
Department	String	Specifies the department within the organization.
Description	String	The description of the organization.
Title	String	The user's title within the organization.
CostCenter	String	The cost center of the user's organization.
Location	String	The physical location of the organization.
IsPrimary	Boolean	Indicates if this is the user's primary organization.
Symbol	String	Text string symbol of the organization.
Type	String	Country in the address.
CustomType	String	If the value of type is custom, this property contains the custom type.

UserPhones

Query the phone numbers for a user.

Table Specific Information

Select

To get a list of phones for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserPhones

Columns


Name	Type	Description
PhoneNumber	String	The user's phone number.
UserId	String	The unique identifier for the user.
IsPrimary	String	Indicates if this is the user's primary IM.
CustomType	String	The custom type of the phone number.
Type	String	The type of the phone number.

UserWebsites

Retrieve a list of the websites of a user.

Table Specific Information

Select

To get a list of websites for a user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. Otherwise, the Sync App will automatically use the Id of the first user from the Users table.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM UserWebsites

Columns


Name	Type	Description
URL	String	The URL of the website.
UserId	String	The unique identifier for the user.
CustomType	String	The custom type of the website.
Type	String	The type of the website.
IsPrimary	Boolean	Indicates if this is the user's primary website or not

VerificationCodes

Query verification codes for a user.

Table Specific Information

Select

To get a current set of valid backup verification codes for a specified user, the UserId column is required. It can be set in the connection string or in the WHERE clause condition. If not specified, the Id of the first user from the Users table will be used.

For example, the following query is processed server side by the Google Directory APIs:

SELECT * FROM VerificationCodes

Columns


Name	Type	Description
UserId	String	The unique ID of the user.
VerificationCode	String	A current verification code for the user.
Etag	String	Etag of the resource.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	The type of authentication to use when connecting to Google Directory.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	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.
DelegatedServiceAccounts	A space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	A service account email to make a delegated request.
Scope	Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.

JWT OAuth

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
CustomerId	Restrict query results to this customer.
Domain	Restrict queries to this domain.
GroupId	Restrict query results to this group.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Google Directory, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UserId	Restrict query results to this user.
WorkloadPoolId	The ID of your Workload Identity Federation pool.
WorkloadProjectId	The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderId	The ID of your Workload Identity Federation pool provider.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The type of authentication to use when connecting to Google Directory.

AuthScheme

The type of authentication to use when connecting to Google Directory.

Remarks

OAuth: Set this to perform OAuth authentication using a standard user account.
OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
GCPInstanceAccount: Set this to get Access Token from Google Cloud Platform instance.
AWSWorkloadIdentity: Set this to authenticate using Workload Identity Federation. The Sync App authenticates to AWS according to the AWSWorkloadIdentityConfig and provides Google Security Token Serivce with an authentication token. The Google STS validates this token and produces an OAuth token that can access Google services.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	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.
DelegatedServiceAccounts	A space-delimited list of service account emails for delegated requests.
RequestingServiceAccount	A service account email to make a delegated request.
Scope	Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

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.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

DelegatedServiceAccounts

A space-delimited list of service account emails for delegated requests.

Remarks

The service account emails must be specified in a space-delimited list.

Each service account must be granted the roles/iam.serviceAccountTokenCreator role on its next service account in the chain.

The last service account in the chain must be granted the roles/iam.serviceAccountTokenCreator role on the requesting service account. The requesting service account is the one specified in the RequestingServiceAccount property.

Note that for delegated requests, the requesting service account must have the permission iam.serviceAccounts.getAccessToken, which can also be granted through the serviceAccountTokenCreator role.

RequestingServiceAccount

A service account email to make a delegated request.

Remarks

The service account email of the account for which the credentials are requested in a delegated request. With the list of delegated service accounts in DelegatedServiceAccounts, this property is used to make a delegated request.

You must have the IAM permission iam.serviceAccounts.getAccessToken on this service account.

Scope

Specifies the scope of the authenticating user's access to the application. Generally specified at the time the custom OAuth application is created (if necessary), so that the authenticating user can obtain the the level of access appropriate to their credentials.

Remarks

Scopes are set to define what kind of access the authenticating user will have; for example, read, read and write, restricted access to sensitive information. System administrators can use scopes to selectively enable access by functionality or security clearance.

When InitiateOAuth is set to GETANDREFRESH, you must use this property if you want to change which scopes are requested. When InitiateOAuth is set to either REFRESH or OFF, you can use either this property or the Scope input to change which scopes are requested.

JWT OAuth

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.

OAuthJWTCert

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:


USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.
GOOGLEJSON	The certificate store is the name of a JSON file containing the service account information. Only valid when connecting to a Google service.
GOOGLEJSONBLOB	The certificate store is a string that contains the service account JSON. Only valid when connecting to a Google service.

OAuthJWTCertPassword

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys are not encrypted.

OAuthJWTCertSubject

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

OAuthJWTIssuer

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. Enter the value of the service account email address.

This is not required when using the GOOGLEJSON OAuthJWTCertType. Google JSON keys contain a copy of the issuer account.

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. Enter the email address of the user for which the application is requesting delegated access.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Google Directory. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Google Directory. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Google Directory. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\GoogleDirectory Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AWSWorkloadIdentityConfig	Configuration properties to provide when using Workload Identity Federation via AWS.
CustomerId	Restrict query results to this customer.
Domain	Restrict queries to this domain.
GroupId	Restrict query results to this group.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
Pagesize	Specifies the maximum number of results to return from Google Directory, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.
UserId	Restrict query results to this user.
WorkloadPoolId	The ID of your Workload Identity Federation pool.
WorkloadProjectId	The ID of the Google Cloud project that hosts your Workload Identity Federation pool.
WorkloadProviderId	The ID of your Workload Identity Federation pool provider.

AWSWorkloadIdentityConfig

Configuration properties to provide when using Workload Identity Federation via AWS.

Remarks

The properties are formatted as a semicolon-separated list of Key=Value properties, where the value is optionally quoted. For example, this setting authenticates in AWS using a user's root keys:

AWSWorkloadIdentityConfig="AuhtScheme=AwsRootKeys;AccessKey='AKIAABCDEF123456';SecretKey=...;Region=us-east-1"

CustomerId

Restrict query results to this customer.

Remarks

This property can be set in the connection string or query. Otherwise, the Sync App will use the Customer Id of the authenticated user. You can also get this value from the Users table.

Domain

Restrict queries to this domain.

Remarks

The domain name (e.g., cdata.com). Use this connection property to get results from only one domain.

GroupId

Restrict query results to this group.

Remarks

This property must be set in the connection string or query. Otherwise, the Sync App will use the first found Group Id. You can get this value from the Groups table.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

Pagesize

Specifies the maximum number of results to return from Google Directory, per page. This setting overrides the default page size set by the datasource, which is optimized for most use cases.

Remarks

You may want to adjust the default pagesize to optimize results for a particular object or service endpoint you are querying. Be aware that increasing the page size may improve performance, but it could also result in higher memory consumption per page.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM Group WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

UserId

Restrict query results to this user.

Remarks

The Id of the user. If not specified, the first user from the Users table will be used.

WorkloadPoolId

The ID of your Workload Identity Federation pool.

Remarks

The ID of your Workload Identity Federation pool.

WorkloadProjectId

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

Remarks

The ID of the Google Cloud project that hosts your Workload Identity Federation pool.

WorkloadProviderId

The ID of your Workload Identity Federation pool provider.

Remarks

The ID of your Workload Identity Federation pool provider.

Google Directory Connector for CData Sync

Google Directory Connector for CData Sync

Overview

Google Directory Version Support

Establishing a Connection

Adding a Connection to Google Directory

Authenticating to Google Directory

User Accounts (OAuth)

Web Applications

Headless Machines

GCP Instance Accounts

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Views

Stored Procedures

Tables

Google Directory Connector for CData Sync Tables

ChromeOsDevices

Table Specific Information

Select

INSERT

Update

Delete

Columns

Pseudo-Columns

DomainAliases

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Domains

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

GroupAliases

Table Specific Information

Select

Insert

Update

Delete

Columns

GroupMembers

Table Specific Information

Select

Insert

Update

Delete

Columns

Groups

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Notifications

Table Specific Information

Select

INSERT

Update