On this page
Table of Contents | ||||
---|---|---|---|---|
|
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 Pipelines. | |||||||||||||
Account: | This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See /wiki/spaces/DRWIP/pages/1438788Google Directory Account 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 | |||||||||||||
|
|
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
JSON for Deleting a User or a User.Photo
Code Block |
---|
[ { "userKey": "user@example.com" } ] |
JSON for Deleting an Orgunit
Code Block |
---|
[ { "customerID": "#########", "orgUnitPath": "TestOrg/SubOrg" } ] |
Note |
---|
The orgUnitPath does not take an initial backslash. If one is added, the orgunit will not be found. |
JSON for Deleting a Group
Code Block |
---|
[ { "groupKey": "testgroup@example.com" } ] |
See Also
Insert excerpt | ||||||
---|---|---|---|---|---|---|
|