Google Directory Insert

Overview

The Google Directory Insert Snap creates 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.
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 Insert
Resource

Dropdown list*		 The type of resource to be created.

The options available include:

  • user
  • orgunit
  • group

Default value: user

Example: group
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

The following attributes must be passed through to the Google Directory Insert Snap for the insert to process.

Note: If the information provided for these attributes does not match the expected format (such as an email address with an incorrect domain), you may receive a "forbidden" error message. Verify your information is correct before continuing.

User

  • name object with familyName and givenName - All required.
  • password - Required.
  • primaryEmail - Required.
  • See the API documentation referenced at the bottom of the page for the complete list of optional 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.

Note:

  • hashFunction is set to MD5.
  • changePasswordAtNextLogin is set to false.

Orgunit

  • name - Required.
  • parentOrgUnitPath - Required.

Group

  • email - Required.
  • description - Optional.
  • name - Optional.
Refer to the following documentation for information about the input data: