The EmaiI Signature Web Portal - Help Center

IT Pro: How to read users from Google Directory



Google Directory integration is managed under Preferences > Integration > Google Directory

Open the page and check the "Enable Google Directory integration" box.

Then click "Link Google Account" button and log on to your G Suite admin account.

On the next window, grant Xink application offline accesses to the directory.

Then click Check Google connectivity to verify Xink connectivity to the directory.

Click Save to save preferences.

Import sequence is started once in an hour. Actual import delay might differ depending on current service load. You may trigger an update under Dashboard> Schedule Update


How to apply filter when importing Google directory users to Xink.

You use the query string without escaping the URL.

The query parameter is entered in the same way as described in the Examples section of the page:
https://developers.google.com/admin-sdk/directory/v1/guides/search-users

Default Filter Examples:

1. Import users with a givenName OR familyName that contains a value.

name='John' 


2. Import for users in a given country.

addressCountry='United Kingdom'


3. Import users with SMTP address that ends with @company.com

email:*@company.com


4. Import only the users in a specific organization.

orgName=Engineering 


5. Import only the users with the same direct manager.

directManager='JohnDoe@xink.io'  


6. Combination of server-side and client-side filter.
Import users that are active and with SMTP address that ends with @company.com

IsSuspended=false
$.mail != null && $.mail.indexOf('@company.com') > -1


7. Import only the users contained a specified Google Directory Organizational Unit (OU).

orgUnitPath=/Denmark

OR

orgUnitPath=/Denmark/Users/Standard


NOTE: Use ' ' if the target OU has space ex. OrgUnitPath='/United Kingdom'



Client-side Filter

The client-side filter is used if you have a complex query that cannot be supported by the G Suite Directory API(Server-side filter).
The client-side filter can work in combination with Server-side filters.
The Javascript syntax is used in Client-Side filtering. Learn more about Java SYNTAX and OPERATORS
Only Google Directory attributes defined HERE can be used for your filter.

Examples below:

1. This filter will import only users with the specified @domain, for example, all users with @xink.io

$.mail != null && $.mail.indexOf('@xink.io') > -1


2. This filter will import only users with a last name.

$.sn != null && $.sn.length > 0


3. This filter will import all users with the specified email domains(domain1.com and domain2.com)

$.mail != null && ($.mail.indexOf('@domain1.com') > -1 || $.mail.indexOf('@domain2.com') > -1)


4. Import only users with a job title which is an easy way to filter out 'non-real' user

$.title != null && $.title.length > 0


5. Import users from the specified departments(Marketing or Support Team)

$.department == "Marketing" && $.department == "Support Team"



6. Import users from the specified company name

$.company == "Company Name" 


7. Import all active users Excluding the following the specified OrgUnitPath and Department.

IsSuspended=false
$.orgUnitPath != null && $.orgUnitPath.indexOf('/Denmark') == -1 && $.orgUnitPath.indexOf('/United Kingdom') == -1 && $.orgUnitPath.indexOf('/Australia') == -1 && $.department != "External"



NOTE: In Client-Side filtering, check connectivity will not show the number of users that met the filter conditions but will be imported.


Learn more

IT Pro: Fields that are pulled from Google Directory by default.
How to map custom fields from Google Directory
IT Pro: How to read groups from Google Directory.




Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.