On this Page

Snap type:

Read

Description:

This Snap reads the data of the users, user photos, groups and org units in Google Directory.

Expected upstream Snaps: File reader followed by any file parser followed by Structure.
Expected downstream Snaps: Any file Formatter followed by File Writer.
Expected input: Resource type and Filter attributes(Filter keys, Filter values)
Expected output: The data for the resource type provided.

Prerequisites:

[None]

Support and limitations:

Works in Ultra Tasks.

Account:

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Google Directory Accounts for information on setting up this type of account.

Verify that you have the correct Application scope defined for your account. See Google Directory Application Scope for more information.
Access tokens for Google Directory accounts expire in one hour.

Views:

Input	This Snap has at most one document input view.
Output	This Snap has exactly one document output view.
Error	This Snap has at most one document error view and produces zero or more documents in the view.

Settings

Label

Required. The name for the Snap. You can modify this to be more specific, especially if you have more than one of the same Snap in your pipeline.

Resource

Required. The type of resource to be created.

The options available include:

user - userKey required if calling the Users Get API.
userPhoto - userKey required.
orgunit - customerID and GetOrgUnitPath or ListOrgUnitPath must be specified as Filter attributes.
group - groupKey required if calling the Groups Get API.

Default value: user

Filter Attributes-
(Filter Keys, Filter values)

Filter keys - The suggested filter attributes based on the provided Resource Type selected.
Filter values - The corresponding values of the suggested filter key to read the resource.

Examples: See below.

Default value: [None]

On empty result

Specify or select the Snap behavior when no matching filter value is found. The available options are:

Ignore: Select this option if you do not require an output document.

Error: Select this option if you want to send an error document to the error view.

Output: Select this option if you want an empty output document.

If you do not choose any of the options for On empty result (an empty space), the behavior of Snap for empty results remains consistent with its previous state.
If the resource type is userPhoto, the On empty result property value is not required.

Default value: space

Examples: Ignore

Snap execution

Select one of the three modes in which the Snap executes. Available options are:

Validate & Execute: Performs limited execution of the Snap, and generates a data preview during Pipeline validation. Subsequently, performs full execution of the Snap (unlimited records) during Pipeline runtime.
Execute only: Performs full execution of the Snap during Pipeline execution without generating preview data.
Disabled: Disables the Snap and all Snaps that are downstream from it.

Supported Filter Attributes by Resource

User

userKey - Required for Users Get API. Set the expression toggle (=) off and enter the userKey.
domain - Optional. Set the expression toggle (=) off and enter the domain.
showDeleted - Optional. Set the expression toggle (=) off and enter true | false.
fields - Optional. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.
query - Optional. Set the expression toggle (=) off and enter the query without quotation marks.

Learn more about the user fields that are queryable within the user resource.
maxResults - Optional. Set the expression toggle (=) off and enter an integer (1 to 500, inclusive).
customer - Set the expression toggle (=) off and enter the customerID. If you are an account administrator, you can use the my_customer alias with the expression toggle off.
projection - Optional. Set the expression toggle (=) off and enter custom or full in the Filter value field to retrieve the schema field.
customFieldMask - Optional. Set the expression toggle (=) off and list the custom fields to retrieve custom schema fields.

You can fetch custom fields in a user profile by a comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.

User.Photo

userKey - Required. Set the expression toggle (=) off and enter the userKey.

OrgUnit

customerID - Required. Set the expression toggle (=) off and enter the customerID.
GetOrgUnitPath - Required to call the OrgUnits Get API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
ListOrgUnitPath - Required to call the OrgUnits List API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
type - An optional parameter from the OrgUnits List API. Set the expression toggle (=) off and enter all | children.
fields - An optional parameter for either the OrgUnits Get API or the OrgUnits List API. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.

Group

groupKey - Required for Groups Get API. Set the expression toggle (=) off and enter the groupKey.
customer - Set the expression toggle (=) off and enter the customerID. If you are an account administrator, you can use the my_customer alias with the expression toggle off.
domain - Optional. Set the expression toggle (=) off and enter the domain.
maxResults - Optional. Set the expression toggle (=) off and enter an integer.
fields - Optional. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.
userKey - Optional. Set the expression toggle (=) off and enter the userKey. Returns all groups to which this user belongs.

Troubleshooting

Error Reason Resolution

Error	Reason	Resolution
`Failure: IO error occurred`	`400 Bad Request GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits { "code": 400, "errors": [ { "domain": "global", "message": "Invalid Customer Id", "reason": "invalid" } ], "message": "Invalid Customer Id" },`	Provide the customerID as Google Service Account is not associated with any customer. Ensure that the scope is correctly defined for the action/resource being executed.
`directory/v1/groups?customer=my_customer { "code": 404, "errors": [ { "domain": "global", "message": "Domain not found.", "reason": "notFound" } ], "message": "Domain not found." }`	Either provide customer or domain information as Google Service Account is not associated with any customer or domain.

Failure: IO error occurred

400 Bad Request GET https://admin.googleapis.com/admin/directory/v1/customer/my_customer/orgunits { "code": 400, "errors": [ { "domain": "global", "message": "Invalid Customer Id", "reason": "invalid" } ], "message": "Invalid Customer Id" },

Provide the customerID as Google Service Account is not associated with any customer. Ensure that the scope is correctly defined for the action/resource being executed.

directory/v1/groups?customer=my_customer { "code": 404, "errors": [ { "domain": "global", "message": "Domain not found.", "reason": "notFound" } ], "message": "Domain not found." }

Either provide customer or domain information as Google Service Account is not associated with any customer or domain.

Examples

Refer to the example - Perform End-to-End Operations in Google Directory.

The following tables provides sample:

Resource	Filter key	Filter value	Result
userPhoto	userkey	(expression toggle (=) off) user@example.com	Returns the resource data for the user's photo.
user	[None]	[None]	Returns all users.
user	domain	(expression toggle (=) off) example.com	Returns all users within the specified domain.
user	showDeleted	(expression toggle (=) off) true	Returns deleted users.
user	customer	(expression toggle (=) off) my_customer	Returns all users for the customer ID if the account is an account administrator.
user	fields	(expression toggle (=) off) users(aliases,name,primaryEmail)	Returns the name, primary email and email aliases for all users.
user	query	(expression toggle (=) off) isAdmin=true	Returns all admins.
user	query	(expression toggle (=) off) givenName:Tim*	Returns all users whose givenName starts with Tim.
orgunit	fields	(expression toggle (=) off) kind,name,orgUnitPath	Returns kind,name,orgUnitPath fields of the orgunits.

Snap Pack History

Click to view/expand

Release	Snap Pack Version	Date	Type	Updates
February 2025	main29887	12 Feb 2025	Stable	Updated and certified against the current SnapLogic Platform release.
November 2024	main29029	13 Nov 2024	Stable	Updated and certified against the current SnapLogic Platform release.
August 2024	main27765	21 Aug 2024	Stable	Added Google Service Account to connect Google Directory Snaps to a data source.
May 2024	main26341	08 May 2024	Stable	Updated and certified against the current SnapLogic Platform release.
February 2024	436patches26168	29 Apr 2024	Latest	Enhanced the Google Directory Read Snap with an On empty result dropdown list that enables you to select the Snap behavior when no matching filter value is found.
February 2024	436patches25581	18 Mar 2024	Latest	Fixed an issue with the Google Directory Read Snap that displayed a `null pointer exception` when the Filter attributes field set was configured with key-value entries.
February 2024	main25112	14 Feb 2024	Stable	Updated and certified against the current SnapLogic Platform release.
November 2023	main23721	08 Nov 2023	Stable	Updated and certified against the current SnapLogic Platform release.
August 2023	main22460	16 Aug 2023	Stable	Updated and certified against the current SnapLogic Platform release.
May 2023	433patches22103	27 Jul 2023	Latest	Fixed an issue with Google Directory Update Snap that could not add or update organizations and displayed the error, `IO error occurred`. The Snap now works as expected, allowing you to update the organization and IMS details successfully.
May 2023	main21015	10 May 2023	Stable	Upgraded with the latest SnapLogic Platform release.
February 2023	main19844	09 Feb 2023	Stable	Upgraded with the latest SnapLogic Platform release.
November 2022	main18944	10 Nov 2022	Stable	Upgraded with the latest SnapLogic Platform release.
August 2022	main17386	11 Aug 2022	Stable	The original payload is passed to the error view in the Google Directory Insert Snap. The original payload is displayed under the `original` tag in the Google Directory Update Snap.
4.29 Patch	429patches16728	21 Jul 2022	Latest	Enhanced the Google Directory Insert Snap where the Snap did not display the original payload in the error view. Now, the original payload is passed to the error view. Enhanced the Google Directory Update Snap where the original payload is displayed in the error view, but not under the original tag. Now the original payload is displayed under the original tag.
4.29	main15993	14 May 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.28	main14627	12 Feb 2022	Stable	Upgraded with the latest SnapLogic Platform release.
4.27	main12833	13 Nov 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.26	main11181	14 Aug 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.25	main9554	08 May 2021	Stable	Enhanced the Google Directory Insert and Google Directory Update Snaps to support custom schema attributes. You can fetch these custom fields and their values in a user profile by adding them as custom schema attributes to upstream Snaps.

4.24 Patch	424Patch8638	02 Mar 2021	Latest	Enhanced the Google Directory Read Snap by introducing two new field attributes, projection and customFieldMask, to retrieve custom schema fields.
4.24	main8556	13 Feb 2021	Stable	Upgraded with the latest SnapLogic Platform release.
4.23 Patch	423Patch7817	13 Jan 2021	Latest	Fixed the authorization issue in the Snap Pack by migrating to a verified Google OAuth application.
4.23	main7430	14 Nov 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.22	main6403	12 Sep 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.21	snapsmrc542	09 May 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.20	snapsmrc535	08 Feb 2020	Stable	Upgraded with the latest SnapLogic Platform release.
4.19	snaprsmrc528	14 Nov 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.18	snapsmrc523	10 Aug 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.17	ALL7402	11 Jun 2019	Latest	Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.
4.17	snapsmrc515	11 Jun 2019	Latest	Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.
4.16	snapsmrc508	16 Feb 2019	Stable	Upgraded with the latest SnapLogic Platform release.
4.15	snapsmrc500	15 Dec 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.14	snapsmrc490	11 Aug 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.13	snapsmrc486	12 May 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.12	snapsmrc480	17 Feb 2018	Stable	Upgraded with the latest SnapLogic Platform release.
4.11	snapsmrc465	11 Nov 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.10	snapsmrc414	12 Aug 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.9	snapsmrc405	13 May 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.8	snapsmrc398	11 Feb 2017	Stable	Upgraded with the latest SnapLogic Platform release.
4.7	snapsmrc382	23 Nov 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.6	snapsmrc362	13 Aug 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.5.1	snapsmrc344	18 May 2016	Stable	Upgraded with the latest SnapLogic Platform release.
4.5	snapsmrc344	18 May 2016	Stable	Enhanced the error view output to include error, reason, and resolution.

Browser not supported