On this Page

Supported Attributes by Resource

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

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.

Examples

Perform End-to-End Operations in Google Directory

The following example pipeline demonstrates the use of the Google Directory Insert, Update, Patch, Read, and Delete Snaps in a complete process, from record insertion to deletion at the endpoint.

Download this pipeline.

Step 1: Configure the Mapper Snap with the primaryEmail, familyName, and givenName fields as follows:

Step 2: Configure the Google Directory Insert Snap to insert specific details of the user. On validation, the output displays the email ID, familyName, and givenName values, which indicate that these values are inserted in the Google Directory.

Step 3: Configure the Mapper Snap to pass the primaryEmail.

Step 4: Connect the Mapper Snap with the Copy Snap to create four copies of the output.

Step 5: Configure the Script Snaps at the output views of the Copy Snap to halt the pipeline for a specified time (100 seconds) to provide some delay between different operations like such as update/, patch/, read/, and delete.

Step 6: Perform the Update, Patch, Read, and Delete operations on the output documents from the Copy Snap.

First output view: Configure the Mapper Snap to get the primary email ID from the Copy Snap and update the familyName and givenName fields.

Configure the Google Directory Update Snap to update the values in the record for the specified primary email ID. On validation, the Snap displays the updated values.

Second output view: Configure the Mapper Snap to get the primary email ID and update the familyName, giveName, and recovery email ID fields.

Configure the Google Directory Update Snap with patch action to update the values in the record for the specified primary email ID. On validation, the Snap displays the updated values.

Third output view:Configure the Google Directory Read Snap to read the record with the primary email ID updated in the Google Directory Insert Snap. On validation, the inserted record inserted is displayed displays in the output.

Fourth output view: Configure the Mapper Snap to get the primary email ID from the fourth output view of the Copy Snap and the email ID to the Google Directory Delete Snap.

Configure the GoogleDirectory Google Directory Delete Snap to delete the record for the passed primary email ID. On validation, the Snap displays the success message after deleting the record.

JSON for Inserting a User (Basic)

[
    {
        "name": {
            "familyName": "Account",
            "givenName": "Google"
        },
        "password": "test123it",
        "primaryEmail": "googleaccount@example.com"
    }
]
 

JSON for Inserting a Group

[
    {
        "email": "googletestgroup@example.com"
    }
]
 
 

JSON for Inserting an Orgunit

[
    {
        "customerID": "C04a4dvn5",
        "name": "TestOrgABeta",
        "parentOrgUnitPath": "/TestOrg/Subtest"
    }
]
 

Related content:

Refer to the following documentation for information on the input data: 

• For users: https://developers.google.com/admin-sdk/directory/v1/reference/users/insert
• For groups: https://developers.google.com/admin-sdk/directory/v1/reference/groups/insert
• For orgunits: https://developers.google.com/admin-sdk/directory/v1/reference/orgunits/insert