Google Directory Delete
On this page
Snap type: | Write | |||||||
---|---|---|---|---|---|---|---|---|
Description: | This Snap deletes users, user photos, groups and org units in Google Directory.
| |||||||
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.
| |||||||
Views: |
| |||||||
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:
Default value: user | |||||||
Snap execution | Select one of the three modes in which the Snap executes. Available options are: 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 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.
Group
- groupKey - The group in the API request. The value can be the group's email address, group alias, or the unique group ID.
Examples
Refer to the example - Perform End-to-End Operations in Google Directory.
JSON for Deleting a User or a User.Photo
[ { "userKey": "user@example.com" } ]
JSON for Deleting an Orgunit
[ { "customerID": "#########", "orgUnitPath": "TestOrg/SubOrg" } ]
JSON for Deleting a Group
[ { "groupKey": "testgroup@example.com" } ]