Google Directory Update

Overview

The Google Directory Update Snap updates users, groups and org units in Google Directory.

Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has exactly one document input view.

Expected input: Resource type and input data.
  • File reader followed by any file parser followed by Structure
Output

This Snap has exactly one document output view.

Expected output: The data for the resource type provided.
Learn more about Error handling.

Snap settings

Note: Learn about the common controls in the Snap settings dialog.
Field/Field set Description
Label

String*

Required. Specify a unique name for the Snap. Modify this to be more appropriate, especially if more than one of the same Snaps is in the pipeline.

Default value: Google Directory Update
Resource

Dropdown list*		 The type of resource to be updated.

The options available include:

  • user
  • userPhoto
  • orgunit
  • group

Default value: user

Example: group
Action

Dropdown list*		 The type of action to perform. The options available include:
  • update
  • patch

Use the patch option to send only the data for the specific fields you are updating and minimize the size of the update request. See Google's documentation on Patch (partial update) for more information.

Default value: update

Example: patch
Snap execution

Dropdown list
Choose 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 Attributes by Resource

User

  • userKey - Required.
  • See the API documentation referenced at the bottom of the page for the complete list of optional field properties.
Note: You can write and update custom fields in a user profile. You must define the custom schema on the domain prior to use.

User.Photo

  • userkey - Required.
  • photoData - Required for update.

Note: photoData should be provided as a base64 string.

  • See the API documentation referenced at the bottom of the page for the complete list of optional field properties.

Group

  • groupKey - Required.
  • See the API documentation referenced at the bottom of the page for the complete list of optional field properties.

OrgUnit

  • customerID - Required.
  • orgUnitPath - Required.
  • See the API documentation referenced at the bottom of the page for the complete list of optional field properties.