Portal for Support Agents

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 filter users

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

Examples:

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

name='John' 

Import for users in a given country.

addressCountry='United Kingdom'

Import users matching an email prefix.

email:admin*

Import users in a specific organization.

orgName=Engineering 

Import users with the same direct manager: (See screenshot below)

directManager='JohnDoe@xink.io'  

Import users with the specified direct manager AND job title (both conditions must be met)

directManager='JohnDoe@xink.io' orgTitle='Sr. Support Engineer'

Client-side Filter

The client-side filter is used if you have a complex query that cannot be supported by the Gsuite 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:

Import only users with a job title which is an easy way to filter 'real' users:

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

Import users from either the specified departments(Dev Team or Support Team).

$.department == "Dev Team" || $.department == "Support Team"

In Client-side filter, check connectivity will not show the number of users that met the filter conditions.


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.