Skip to Content

Google Directory Connection Details

Introduction

Connector Version

This documentation is based on version 22.0.8665 of the connector.

Get Started

Google Directory Version Support

Establish a Connection

Authenticate to Google Directory

The connector supports using user accounts, service 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.

Desktop Applications

provides an embedded OAuth application that simplifies OAuth desktop Authentication. Alternatively, you can create a custom OAuth application. See Creating a Custom OAuth App for information about creating custom applications and reasons for doing so.

For authentication, the only difference between the two methods is that you must set two additional connection properties when using custom OAuth applications.

After setting the following connection properties, you are ready to connect:

  • InitiateOAuth: Set this to GETANDREFRESH, which instructs the connector to automatically attempt to get and refresh the OAuth access token.
  • 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.

When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process as follows:

  • Extracts the access token from the callback URL.
  • Obtains a new access token when the old one expires.
  • Saves OAuth values in OAuthSettingsLocation that persist across connections.
Web Applications

When connecting via a Web application, you need to create and register a custom OAuth application with Google Directory. You can then use the connector to acquire and manage the OAuth token values. See Creating a Custom OAuth App 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:

  1. 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.
  2. 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.
  3. 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 path where the connector 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 need to authenticate on another device that has an internet browser.

  1. 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 connector 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.
  2. Then configure the connector 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.

  1. 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. 2. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code. 3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to 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 file.

After the OAuth settings file is generated, you need to 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 file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to 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 path 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 path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.
Service Accounts (OAuthJWT)

To authenticate using a service account, you must create a new service account and have a copy of the accounts certificate. If you do not already have a service account, you can create one by following the procedure in Creating a Custom OAuth App.

For a JSON file, set these properties:

  • AuthScheme: Set this to OAuthJWT.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to GOOGLEJSON.
  • OAuthJWTCert: Set this to the path to the .json file provided by Google.
  • OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.

For a PFX file, set these properties instead:

  • AuthScheme: Set this to OAuthJWT.
  • InitiateOAuth: Set this to GETANDREFRESH.
  • OAuthJWTCertType: Set this to PFXFILE.
  • OAuthJWTCert: Set this to the path to the .pfx file provided by Google.
  • OAuthJWTCertPassword: (optional) Set this to the .pfx file password. In most cases you must provide this since Google encrypts PFX certificates.
  • OAuthJWTCertSubject: (optional) Set this only if you are using a OAuthJWTCertType which stores multiple certificates. Should not be set for PFX certificates generated by Google.
  • OAuthJWTIssuer: Set this to the email address of the service account. This address will usually include the domain iam.gserviceaccount.com.
  • OAuthJWTSubject: (optional) Only set this value if the service account is part of a GSuite domain and you want to enable delegation. The value of this property should be the email address of the user whose data you want to access.
GCP Instance Accounts

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

Important Notes

Configuration Files and Their Paths

  • All references to adding configuration files and their paths refer to files and locations on the Harmony Agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.

Advanced Features

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

User Defined Views

The connector allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Proxy

To configure the connector using Private Agent proxy settings, select the Use Proxy Settings checkbox on the connection configuration screen.

Query Processing

The connector 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).

See Query Processing for more information.

User Defined Views

The Google Directory connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.

There are two ways to create user defined views:

  • Create a JSON-formatted configuration file defining the views you want.
  • DDL statements.

Define Views Using a Configuration File

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom 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)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Define Views Using DDL Statements

The connector is also capable of creating and altering the schema via DDL Statements such as CREATE LOCAL VIEW, ALTER LOCAL VIEW, and DROP LOCAL VIEW.

Create a View

To create a new view using DDL statements, provide the view name and query as follows:

CREATE LOCAL VIEW [MyViewName] AS SELECT * FROM Customers LIMIT 20;

If no JSON file exists, the above code creates one. The view is then created in the JSON configuration file and is now discoverable. The JSON file location is specified by the UserDefinedViews connection property.

Alter a View

To alter an existing view, provide the name of an existing view alongside the new query you would like to use instead:

ALTER LOCAL VIEW [MyViewName] AS SELECT * FROM Customers WHERE TimeModified > '3/1/2020';

The view is then updated in the JSON configuration file.

Drop a View

To drop an existing view, provide the name of an existing schema alongside the new query you would like to use instead.

DROP LOCAL VIEW [MyViewName]

This removes the view from the JSON configuration file. It can no longer be queried.

Schema for User Defined Views

User Defined Views are exposed in the UserViews schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName property.

Work with User Defined Views

For example, a SQL statement with a User Defined View called UserViews.RCustomers only lists customers in Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

An example of a query to the driver:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Resulting in the effective query to the source:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.

SSL Configuration

Customize the SSL Configuration

By default, the connector attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Data Model

The Google Directory connector models Google Directory APIs as relational tables, views, and stored procedures. API limitations and requirements for the available objects are documented in this section. The connector offloads as much of the SELECT statement processing as possible to the Google Directory APIs and then processes the rest of the query in memory; API limitations and requirements are documented in Tables and Views.

See SupportEnhancedSQL for more information on how the connector circumvents API limitations with in-memory client-side processing.

Tables

The connector 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 connector models the data in Google Directory into a list of tables that can be queried using standard SQL statements.

Generally, querying Google Directory tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.

Google Directory Connector 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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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 connector processes other queries client-side in memory.

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 connector processes other queries client-side in memory.

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 ('john@example.com', '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. The connector processes other queries client-side in memory.

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 ('group@example.com', 'Group Example Name', 'Example Description')
Update

To update a group, the ID is required.

UPDATE Groups SET Email = 'group@example.com', 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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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
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. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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 ('john@example.com', 'John', 'Doe', '12345', true)
Update

To update a user, the ID column is required.

UPDATE Users SET PrimaryEmail = 'john@example.com', 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 composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.

Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard.

Dynamic views, such as queries exposed as views, and views for looking up specific combinations of project_team work items are supported.

Google Directory Connector 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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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 connector will automatically use the UserId of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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 connector will automatically use the ID of the first user from the Users table. The connector processes other queries client-side in memory.

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. The connector processes other queries client-side in memory.

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.

Stored Procedures

Stored procedures are function-like interfaces that extend the functionality of the connector beyond simple SELECT/INSERT/UPDATE/DELETE operations with Google Directory.

Stored procedures accept a list of parameters, perform their intended function, and then return, if applicable, any relevant response data from Google Directory, along with an indication of whether the procedure succeeded or failed.

Google Directory Connector Stored Procedures

Name Description
ChangeAdminStatus Change the admin status of a user.
GenerateVerificationCodes Generate verification codes for a user.
GetOAuthAccessToken Obtains the OAuth access token to be used for authentication with various Google services.
GetOAuthAuthorizationURL Obtains the OAuth authorization URL used for authentication with various Google services.
InvalidateVerificationCodes Invalidate verification codes for a user.
RefreshOAuthAccessToken Obtains the OAuth access token to be used for authentication with various Google services.

ChangeAdminStatus

Change the admin status of a user.

Input
Name Type Description
UserId String ID of the user. The value can be the user's primary email address, alias email address, or unique user ID.
Status String New admin status of the user.

GenerateVerificationCodes

Generate verification codes for a user.

Input
Name Type Description
UserId String ID of the user.

GetOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Note

If, after running this stored procedure, the OAuthRefreshToken was not returned as part of the result set, change the Prompt value to CONSENT and run the procedure again. This forces the app to reauthenticate and send new token information.

Input
Name Type Description
AuthMode String The type of authentication mode to use. The allowed values are APP, WEB. The default value is WEB.
Verifier String The verifier code returned by Google after permission for the app to connect has been granted. WEB AuthMode only.
Scope String The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified. The default value is https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly.
CallbackURL String This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, capitalization, and trailing forward slash ('/').
Prompt String This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
AccessType String This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user. The allowed values are ONLINE, OFFLINE. The default value is OFFLINE.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to Google authorization server and back. Uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String A token that may be used to obtain a new access token.
ExpiresIn String The remaining lifetime on the access token.

GetOAuthAuthorizationURL

Obtains the OAuth authorization URL used for authentication with various Google services.

Input
Name Type Description
Scope String The scope of access to Google APIs. By default, access to all APIs used by this data provider will be specified. The default value is https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly https://www.googleapis.com/auth/admin.directory.domain.readonly https://www.googleapis.com/auth/admin.directory.user.readonly https://www.googleapis.com/auth/admin.directory.user.alias.readonly https://www.googleapis.com/auth/admin.directory.group.member.readonly https://www.googleapis.com/auth/admin.directory.group.readonly https://www.googleapis.com/auth/admin.directory.orgunit.readonly https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly https://www.googleapis.com/auth/admin.directory.device.mobile.readonly.
CallbackURL String This field determines where the response is sent. The value of this parameter must exactly match one of the values registered in the APIs Console, including the HTTP or HTTPS schemes, case, and trailing forward slash ('/').
Prompt String This field indicates the prompt to present the user. It accepts one of the following values: NONE, CONSENT, SELECT ACCOUNT. The default is SELECT_ACCOUNT, so a given user will be prompted to select the account to connect to. If it is set to CONSENT, the user will see a consent page every time, even if they have previously given consent to the application for a given set of scopes. Lastly, if it is set to NONE, no authentication or consent screens will be displayed to the user. The default value is SELECT_ACCOUNT.
AccessType String This field indicates if your application needs to access a Google API when the user is not present at the browser. This parameter defaults to OFFLINE. If your application needs to refresh access tokens when the user is not present at the browser, then use OFFLINE. This will result in your application obtaining a refresh token the first time your application exchanges an authorization code for a user. The allowed values are ONLINE, OFFLINE. The default value is OFFLINE.
State String This field indicates any state that may be useful to your application upon receipt of the response. Your application receives the same value it sent, as this parameter makes a round-trip to the Google authorization server and back. Possible uses include redirecting the user to the correct resource in your site, using nonces, and mitigating cross-site request forgery.
Result Set Columns
Name Type Description
URL String The URL to complete user authentication.

InvalidateVerificationCodes

Invalidate verification codes for a user.

Input
Name Type Description
UserId String ID of the user.

RefreshOAuthAccessToken

Obtains the OAuth access token to be used for authentication with various Google services.

Input
Name Type Description
OAuthRefreshToken String The refresh token returned from the original authorization code exchange.
Result Set Columns
Name Type Description
OAuthAccessToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
OAuthRefreshToken String The authentication token returned from Google. This can be used in subsequent calls to other operations for this particular service.
ExpiresIn String The remaining lifetime on the access token.

System Tables

You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.

Schema Tables

The following tables return database metadata for Google Directory:

Data Source Tables

The following tables return information about how to connect to and query the data source:

  • sys_connection_props: Returns information on the available connection properties.
  • sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.

Query Information Tables

The following table returns query statistics for data modification queries:

  • sys_identity: Returns information about batch operations or single updates.

sys_catalogs

Lists the available databases.

The following query retrieves all databases determined by the connection string:

SELECT * FROM sys_catalogs
Columns
Name Type Description
CatalogName String The database name.

sys_schemas

Lists the available schemas.

The following query retrieves all available schemas:

SELECT * FROM sys_schemas
Columns
Name Type Description
CatalogName String The database name.
SchemaName String The schema name.

sys_tables

Lists the available tables.

The following query retrieves the available tables and views:

SELECT * FROM sys_tables
Columns
Name Type Description
CatalogName String The database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view.
TableType String The table type (table or view).
Description String A description of the table or view.
IsUpdateable Boolean Whether the table can be updated.

sys_tablecolumns

Describes the columns of the available tables and views.

The following query returns the columns and data types for the Group table:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Group'
Columns
Name Type Description
CatalogName String The name of the database containing the table or view.
SchemaName String The schema containing the table or view.
TableName String The name of the table or view containing the column.
ColumnName String The column name.
DataTypeName String The data type name.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The storage size of the column.
DisplaySize Int32 The designated column's normal maximum width in characters.
NumericPrecision Int32 The maximum number of digits in numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The column scale or number of digits to the right of the decimal point.
IsNullable Boolean Whether the column can contain null.
Description String A brief description of the column.
Ordinal Int32 The sequence number of the column.
IsAutoIncrement String Whether the column value is assigned in fixed increments.
IsGeneratedColumn String Whether the column is generated.
IsHidden Boolean Whether the column is hidden.
IsArray Boolean Whether the column is an array.

sys_procedures

Lists the available stored procedures.

The following query retrieves the available stored procedures:

SELECT * FROM sys_procedures
Columns
Name Type Description
CatalogName String The database containing the stored procedure.
SchemaName String The schema containing the stored procedure.
ProcedureName String The name of the stored procedure.
Description String A description of the stored procedure.
ProcedureType String The type of the procedure, such as PROCEDURE or FUNCTION.

sys_procedureparameters

Describes stored procedure parameters.

The following query returns information about all of the input parameters for the RefreshOAuthAccessToken stored procedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='RefreshOAuthAccessToken' AND Direction=1 OR Direction=2
Columns
Name Type Description
CatalogName String The name of the database containing the stored procedure.
SchemaName String The name of the schema containing the stored procedure.
ProcedureName String The name of the stored procedure containing the parameter.
ColumnName String The name of the stored procedure parameter.
Direction Int32 An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters.
DataTypeName String The name of the data type.
DataType Int32 An integer indicating the data type. This value is determined at run time based on the environment.
Length Int32 The number of characters allowed for character data. The number of digits allowed for numeric data.
NumericPrecision Int32 The maximum precision for numeric data. The column length in characters for character and date-time data.
NumericScale Int32 The number of digits to the right of the decimal point in numeric data.
IsNullable Boolean Whether the parameter can contain null.
IsRequired Boolean Whether the parameter is required for execution of the procedure.
IsArray Boolean Whether the parameter is an array.
Description String The description of the parameter.
Ordinal Int32 The index of the parameter.

sys_keycolumns

Describes the primary and foreign keys.

The following query retrieves the primary key for the Group table:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Group'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
IsKey Boolean Whether the column is a primary key in the table referenced in the TableName field.
IsForeignKey Boolean Whether the column is a foreign key referenced in the TableName field.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.

sys_foreignkeys

Describes the foreign keys.

The following query retrieves all foreign keys which refer to other tables:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
PrimaryKeyName String The name of the primary key.
ForeignKeyName String The name of the foreign key.
ReferencedCatalogName String The database containing the primary key.
ReferencedSchemaName String The schema containing the primary key.
ReferencedTableName String The table containing the primary key.
ReferencedColumnName String The column name of the primary key.
ForeignKeyType String Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key.

sys_primarykeys

Describes the primary keys.

The following query retrieves the primary keys from all tables and views:

SELECT * FROM sys_primarykeys
Columns
Name Type Description
CatalogName String The name of the database containing the key.
SchemaName String The name of the schema containing the key.
TableName String The name of the table containing the key.
ColumnName String The name of the key column.
KeySeq String The sequence number of the primary key.
KeyName String The name of the primary key.

sys_indexes

Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.

The following query retrieves all indexes that are not primary keys:

SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns
Name Type Description
CatalogName String The name of the database containing the index.
SchemaName String The name of the schema containing the index.
TableName String The name of the table containing the index.
IndexName String The index name.
ColumnName String The name of the column associated with the index.
IsUnique Boolean True if the index is unique. False otherwise.
IsPrimary Boolean True if the index is a primary key. False otherwise.
Type Int16 An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3).
SortOrder String The sort order: A for ascending or D for descending.
OrdinalPosition Int16 The sequence number of the column in the index.

sys_connection_props

Returns information on the available connection properties and those set in the connection string.

When querying this table, the config connection string should be used:

jdbc:cdata:googledirectory:config:

This connection string enables you to query this table without a valid connection.

The following query retrieves all connection properties that have been set in the connection string or set through a default value:

SELECT * FROM sys_connection_props WHERE Value <> ''
Columns
Name Type Description
Name String The name of the connection property.
ShortDescription String A brief description.
Type String The data type of the connection property.
Default String The default value if one is not explicitly set.
Values String A comma-separated list of possible values. A validation error is thrown if another value is specified.
Value String The value you set or a preconfigured default.
Required Boolean Whether the property is required to connect.
Category String The category of the connection property.
IsSessionProperty String Whether the property is a session property, used to save information about the current connection.
Sensitivity String The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms.
PropertyName String A camel-cased truncated form of the connection property name.
Ordinal Int32 The index of the parameter.
CatOrdinal Int32 The index of the parameter category.
Hierarchy String Shows dependent properties associated that need to be set alongside this one.
Visible Boolean Informs whether the property is visible in the connection UI.
ETC String Various miscellaneous information about the property.

sys_sqlinfo

Describes the SELECT query processing that the connector can offload to the data source.

Discovering the Data Source's SELECT Capabilities

Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.

Name Description Possible Values
AGGREGATE_FUNCTIONS Supported aggregation functions. AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT Whether COUNT function is supported. YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR The opening character used to escape an identifier. [
IDENTIFIER_QUOTE_CLOSE_CHAR The closing character used to escape an identifier. ]
SUPPORTED_OPERATORS A list of supported SQL operators. =, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY Whether GROUP BY is supported, and, if so, the degree of support. NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
STRING_FUNCTIONS Supported string functions. LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS Supported numeric functions. ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS Supported date/time functions. NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES Indicates tables skipped during replication.
REPLICATION_TIMECHECK_COLUMNS A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication.
IDENTIFIER_PATTERN String value indicating what string is valid for an identifier.
SUPPORT_TRANSACTION Indicates if the provider supports transactions such as commit and rollback. YES, NO
DIALECT Indicates the SQL dialect to use.
KEY_PROPERTIES Indicates the properties which identify the uniform database.
SUPPORTS_MULTIPLE_SCHEMAS Indicates if multiple schemas may exist for the provider. YES, NO
SUPPORTS_MULTIPLE_CATALOGS Indicates if multiple catalogs may exist for the provider. YES, NO
DATASYNCVERSION The Data Sync version needed to access this driver. Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY The Data Sync category of this driver. Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL Whether enhanced SQL functionality beyond what is offered by the API is supported. TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS Whether batch operations are supported. YES, NO
SQL_CAP All supported SQL capabilities for this driver. SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS A string value specifies the preferred cacheOptions.
ENABLE_EF_ADVANCED_QUERY Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. YES, NO
PSEUDO_COLUMNS A string array indicating the available pseudo columns.
MERGE_ALWAYS If the value is true, The Merge Mode is forcibly executed in Data Sync. TRUE, FALSE
REPLICATION_MIN_DATE_QUERY A select query to return the replicate start datetime.
REPLICATION_MIN_FUNCTION Allows a provider to specify the formula name to use for executing a server side min.
REPLICATION_START_DATE Allows a provider to specify a replicate startdate.
REPLICATION_MAX_DATE_QUERY A select query to return the replicate end datetime.
REPLICATION_MAX_FUNCTION Allows a provider to specify the formula name to use for executing a server side max.
IGNORE_INTERVALS_ON_INITIAL_REPLICATE A list of tables which will skip dividing the replicate into chunks on the initial replicate.
CHECKCACHE_USE_PARENTID Indicates whether the CheckCache statement should be done against the parent key column. TRUE, FALSE
CREATE_SCHEMA_PROCEDURES Indicates stored procedures that can be used for generating schema files.

The following query retrieves the operators that can be used in the WHERE clause:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.

Columns
Name Type Description
NAME String A component of SQL syntax, or a capability that can be processed on the server.
VALUE String Detail on the supported SQL or SQL syntax.

sys_identity

Returns information about attempted modifications.

The following query retrieves the Ids of the modified rows in a batch operation:

SELECT * FROM sys_identity
Columns
Name Type Description
Id String The database-generated ID returned from a data modification operation.
Batch String An identifier for the batch. 1 for a single operation.
Operation String The result of the operation in the batch: INSERTED, UPDATED, or DELETED.
Message String SUCCESS or an error message if the update in the batch failed.

Advanced Configurations Properties

The advanced configurations 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. Click the links for further details.

Authentication

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

OAuth

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Scope Specify scope to obtain the initial access and refresh token.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

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.
OAuthJWTCertSubject The subject of the OAuth JWT 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 The certificate to be accepted from the server when connecting using TLS/SSL.

Schema

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Miscellaneous

Property Description
CustomerId Restrict query results to this customer.
Domain Restrict queries to this domain.
GroupId Restrict query results to this group.
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Google Directory.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.
UserId Restrict query results to this user.

Authentication

This section provides a complete list of authentication properties you can configure.

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.

Possible Values

Auto, OAuth, OAuthJWT, GCPInstanceAccount

Data Type

string

Default Value

Auto

Remarks
  • Auto: Lets the driver decide automatically based on the other connection properties you have set.
  • 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.

OAuth

This section provides a complete list of OAuth properties you can configure.

Property Description
InitiateOAuth Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
OAuthClientId The client ID assigned when you register your application with an OAuth authorization server.
OAuthClientSecret The client secret assigned when you register your application with an OAuth authorization server.
OAuthAccessToken The access token for connecting using OAuth.
OAuthSettingsLocation The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.
CallbackURL The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Scope Specify scope to obtain the initial access and refresh token.
OAuthVerifier The verifier code returned from the OAuth authorization URL.
OAuthRefreshToken The OAuth refresh token for the corresponding OAuth access token.
OAuthExpiresIn The lifetime in seconds of the OAuth AccessToken.
OAuthTokenTimestamp The Unix epoch timestamp in milliseconds when the current Access Token was created.

InitiateOAuth

Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.

Possible Values

OFF, GETANDREFRESH, REFRESH

Data Type

string

Default Value

OFF

Remarks

The following options are available:

  1. OFF: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.
  2. GETANDREFRESH: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.
  3. REFRESH: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.

OAuthClientId

The client ID assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.

OAuthClientSecret

The client secret assigned when you register your application with an OAuth authorization server.

Data Type

string

Default Value

""

Remarks

As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret property.

OAuthAccessToken

The access token for connecting using OAuth.

Data Type

string

Default Value

""

Remarks

The OAuthAccessToken property is used to connect using OAuth. The OAuthAccessToken is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.

The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.

OAuthSettingsLocation

The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, this can be held in memory by specifying a value starting with memory://.

Data Type

string

Default Value

%APPDATA%\GoogleDirectory Data Provider\OAuthSettings.txt

Remarks

When InitiateOAuth is set to GETANDREFRESH or REFRESH, the connector saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and allowing the credentials to be shared across connections or processes.

Alternatively to specifying a file path, memory storage can be used instead. Memory locations are specified by using a value starting with 'memory://' followed by a unique identifier for that set of credentials (ex: memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike with the file based storage, you must manually store the credentials when closing the connection with memory storage to be able to set them in the connection when the process is started again. The OAuth property values can be retrieved with a query to the sys_connection_props system table. If there are multiple connections using the same credentials, the properties should be read from the last connection to be closed.

If left unspecified, the default location is "%APPDATA%\GoogleDirectory Data Provider\OAuthSettings.txt" with %APPDATA% being set to the user's configuration directory:

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

CallbackURL

The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.

Data Type

string

Default Value

""

Remarks

During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.

Scope

Specify scope to obtain the initial access and refresh token.

Data Type

string

Default Value

""

Remarks

Specify scope to obtain the initial access and refresh token.

OAuthVerifier

The verifier code returned from the OAuth authorization URL.

Data Type

string

Default Value

""

Remarks

The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.

Authentication on Headless Machines

See to obtain the OAuthVerifier value.

Set OAuthSettingsLocation along with OAuthVerifier. When you connect, the connector exchanges the OAuthVerifier for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH to automate the exchange.

Once the OAuth settings file has been generated, you can remove OAuthVerifier from the connection properties and connect with OAuthSettingsLocation set.

To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.

OAuthRefreshToken

The OAuth refresh token for the corresponding OAuth access token.

Data Type

string

Default Value

""

Remarks

The OAuthRefreshToken property is used to refresh the OAuthAccessToken when using OAuth authentication.

OAuthExpiresIn

The lifetime in seconds of the OAuth AccessToken.

Data Type

string

Default Value

""

Remarks

Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.

OAuthTokenTimestamp

The Unix epoch timestamp in milliseconds when the current Access Token was created.

Data Type

string

Default Value

""

Remarks

Pair with OAuthExpiresIn to determine when the AccessToken will expire.

JWT OAuth

This section provides a complete list of JWT OAuth properties you can configure.

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.
OAuthJWTCertSubject The subject of the OAuth JWT 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.

Data Type

string

Default Value

""

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:

Property Description
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.

Possible Values

GOOGLEJSONBLOB, USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB, GOOGLEJSON

Data Type

string

Default Value

USER

Remarks

This property can take one of the following values:

Property Description
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.
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.

Data Type

string

Default Value

""

Remarks

If the certificate store is of a type that requires a password, this property is used to specify that password in order to open the 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.

Data Type

string

Default Value

*

Remarks

When loading a certificate the subject is used to locate the certificate in the store.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks the first certificate in the certificate store.

The certificate subject is a comma separated list of distinguished name fields and values. For instance "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Common fields and their meanings are displayed below.

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 it must be quoted.

OAuthJWTIssuer

The issuer of the Java Web Token.

Data Type

string

Default Value

""

Remarks

The issuer of the Java Web Token. This is typically either the Client ID or Email Address of the OAuth Application.

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.

Data Type

string

Default Value

""

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

SSL

This section provides a complete list of SSL properties you can configure.

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

SSLServerCert

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

Data Type

string

Default Value

""

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.

Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).

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

Schema

This section provides a complete list of schema properties you can configure.

Property Description
Location A path to the directory that contains the schema files defining tables, views, and stored procedures.
BrowsableSchemas This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC.
Tables This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC.
Views Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC.

Location

A path to the directory that contains the schema files defining tables, views, and stored procedures.

Data Type

string

Default Value

%APPDATA%\GoogleDirectory Data Provider\Schema

Remarks

The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.

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

Platform %APPDATA%
Windows The value of the APPDATA environment variable
Mac ~/Library/Application Support
Linux ~/.config

BrowsableSchemas

This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Data Type

string

Default Value

""

Remarks

Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.

Tables

This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.

Data Type

string

Default Value

""

Remarks

Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Views

Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.

Data Type

string

Default Value

""

Remarks

Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.

This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.

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 that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of miscellaneous properties you can configure.

Property Description
CustomerId Restrict query results to this customer.
Domain Restrict queries to this domain.
GroupId Restrict query results to this group.
MaxRows Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other These hidden properties are used only in specific use cases.
Pagesize The maximum number of results to return per page from Google Directory.
PseudoColumns This property indicates whether or not to include pseudo columns as columns to the table.
Timeout The value in seconds until the timeout error is thrown, canceling the operation.
UserDefinedViews A filepath pointing to the JSON configuration file containing your custom views.
UserId Restrict query results to this user.

CustomerId

Restrict query results to this customer.

Data Type

string

Default Value

my_customer

Remarks

This property can be set in the connection string or query. Otherwise, the connector 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.

Data Type

string

Default Value

""

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.

Data Type

string

Default Value

""

Remarks

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

MaxRows

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Data Type

int

Default Value

-1

Remarks

Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.

Other

These hidden properties are used only in specific use cases.

Data Type

string

Default Value

""

Remarks

The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting
Property Description
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

The maximum number of results to return per page from Google Directory.

Data Type

int

Default Value

100

Remarks

The Pagesize property affects the maximum number of results to return per page from Google Directory. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.

PseudoColumns

This property indicates whether or not to include pseudo columns as columns to the table.

Data Type

string

Default Value

""

Remarks

This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".

Timeout

The value in seconds until the timeout error is thrown, canceling the operation.

Data Type

int

Default Value

60

Remarks

If Timeout = 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.

If Timeout expires and the operation is not yet complete, the connector throws an exception.

UserDefinedViews

A filepath pointing to the JSON configuration file containing your custom views.

Data Type

string

Default Value

""

Remarks

User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json. The connector automatically detects the views specified in this file.

You can also have multiple view definitions and control them using the UserDefinedViews connection property. When you use this property, only the specified views are seen by the connector.

This User Defined View configuration file is formatted as follows:

  • Each root element defines the name of a view.
  • Each root element contains a child element, called query, which contains the custom 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)"
    }
}

Use the UserDefinedViews connection property to specify the location of your JSON configuration file. For example:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

UserId

Restrict query results to this user.

Data Type

string

Default Value

""

Remarks

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