Versions Compared

Old Version 15

changes.mady.by.user Ankur Parekh

Saved on

compared with

New Version Current

changes.mady.by.user Ankur Parekh

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

On this page

Table of Contents
maxLevel2
excludeOlder Versions|Additional Resources|Related Links|Related Information

Snap type:

Write


Description:

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

  • Expected upstream Snaps: File reader followed by any file parser followed by Structure.
  • Expected downstream Snaps: Any file Formatter followed by File Writer.
  • Expected input: Resource type and user key.
  • Expected output:  The specified resource type object key is deleted in Google Directory.


Prerequisites:

[None]


Support and limitations:Works in Ultra Task Pipelines.
Account: 

This Snap uses account references created on the Accounts page of SnapLogic Manager to handle access to this endpoint. See Google Directory AccountAccounts for information on setting up this type of account.

Note
  • Verify that you have the correct Application scope defined for your account. See Google Directory Application Scope for more information.
  • Access tokens for Google Directory accounts expire in one hour. 


Views:


InputThis Snap has at most one document input view.
OutputThis Snap has exactly one document output view.
ErrorThis Snap has at most one document error view and produces zero or more documents in the view.


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:

  • 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 

Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute


Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute

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
Google Directory Snap Pack
Google Directory Snap Pack
nopaneltrue