Versions Compared

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 creates users, groups and org units in Google Directory.

  • Expected upstream SnapsFile reader followed by any file parser followed by Structure.
  • Expected downstream SnapsAny file Formatter followed by File Writer.
  • Expected inputResource type and input data.
  • Expected output The data for the resource type provided.


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 Accounts 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 exactly 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 
  • orgunit
  • group

Default value: user


Multiexcerpt include macro
nameSnap Execution
pageSOAP Execute


Multiexcerpt include macro
nameExecution_Detail_Write
pageSOAP Execute


Supported Attributes by Resource

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

Note

 If the information provided for these attributes does not match the expected format (such as an email address with an incorrect domain), you may receive a "forbidden" error message. Verify your information is correct before continuing.


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

JSON for Inserting a User (Basic)

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

JSON for Inserting a Group

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

JSON for Inserting an Orgunit

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

See Also

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

Insert excerpt
Google Directory Snap Pack
Google Directory Snap Pack
nopaneltrue