Google Directory Delete

Overview

The Google Directory Delete Snap deletes users, user photos, groups, and org units in Google Directory.

Prerequisites

None.

Snap views

Type Description Examples of upstream and downstream Snaps
Input

This Snap has at most one document input view.

Expected input: Resource type and user key.

Output

This Snap has exactly one document output view.

Expected output: The specified resource type object key is deleted in Google Directory.

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 Delete

Resource

Dropdown list*
The type of resource to be deleted.

The options available include:

  • user: If selected, user key is mandatory.
  • userPhoto: If selected, user key is mandatory.
  • orgunit: If selected, customer ID and org unit path are mandatory.
  • group: If selected, group key is mandatory.

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.

Required Attributes by Resource

The following attributes must be passed through to the Google Directory Delete Snap for the delete to process.

User

  • userKey: The user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

User.Photo

  • userKey: The user in the API request. The value can be the user's primary email address, alias email address, or unique user ID.

Orgunit

  • customerID: Required.
  • orgUnitPath: Required.
Note: The orgUnitPath does not take an initial backslash. If one is added, the orgunit will not be found.

Group

  • groupKey: The group in the API request. The value can be the group's email address, group alias, or the unique group ID.