Versions Compared

Old Version 22

changes.mady.by.user Siddharth Menon

Saved on

compared with

New Version 23

changes.mady.by.user Lakshmi Manda

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:

Read


Description:

This Snap reads the data of the 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 Filter attributes(Filter keys, Filter values)
  • 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 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 - userKey required if calling the Users Get API.
  • userPhoto - userKey required.
  • orgunit - customerID and GetOrgUnitPath or ListOrgUnitPath must be specified as Filter attributes.
  • group - groupKey required if calling the Groups Get API.

Default value: user


Filter Attributes-
(Filter Keys, Filter values)


Filter keys - The suggested filter attributes based on the provided Resource Type selected.
Filter values - The corresponding values of the suggested filter key to read the resource.

Examples: See below.

Default value:  [None]


Multiexcerpt include macro
nameSnap Execution
pageAnaplan Read


Multiexcerpt include macro
nameSnap_Execution_Introduced
pageAnaplan Read

  

Supported Filter Attributes by Resource

User

  • userKey - Required for Users Get API. Set the expression toggle (=) off and enter the userKey.
  • domain - Optional. Set the expression toggle (=) off and enter the domain.
  • showDeleted - Optional. Set the expression toggle (=) off and enter true | false.
  • fields - Optional. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.

  • query -  Optional. Set the expression toggle (=) off and enter the query without quotation marks.

    Note

    Learn more about the user fields that are queryable within the user resource.


  • maxResults - Optional. Set the expression toggle (=) off and enter an integer (1 to 500, inclusive).
  • customer -  Set the expression toggle (=) off and enter the customerID. If you are an account administrator, you can use the my_customer alias with the expression toggle off.

  • projection - Optional. Set the expression toggle (=) off and enter custom or full in the Filter value field to retrieve the schema field.

  • customFieldMask - Optional. Set the expression toggle (=) off and list the custom fields to retrieve custom schema fields.

    Note

    You can fetch custom fields in a user profile by a comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when projection=custom.


User.Photo

  • userKey - Required. Set the expression toggle (=) off and enter the userKey.


OrgUnit

  • customerID - Required. Set the expression toggle (=) off and enter the customerID.
  • GetOrgUnitPath - Required to call the OrgUnits Get API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
  • ListOrgUnitPath - Required to call the OrgUnits List API. Set the expression toggle (=) off and list the name of the org without a preceding slash (that is, TestOrg instead of /TestOrg).
  • type - An optional parameter from the OrgUnits List API. Set the expression toggle (=) off and enter all | children.
  • fields - An optional parameter for either the OrgUnits Get API or the OrgUnits List API. Set the expression toggle (=) off and list the fields to return, separated by a comma.  See the API documentation referenced at the bottom of the page for the complete list of fields.

Group

  • groupKey - Required for Groups Get API. Set the expression toggle (=) off and enter the groupKey.
  • customer - Set the expression toggle (=) off and enter the customerID. If you are an account administrator, you can use the my_customer alias with the expression toggle off.
  • domain -  Optional. Set the expression toggle (=) off and enter the domain.
  • maxResults - Optional. Set the expression toggle (=) off and enter an integer.
  • fields -  Optional. Set the expression toggle (=) off and list the fields to return, separated by a comma. See the API documentation referenced at the bottom of the page for the complete list of fields.
  • userKey - Optional. Set the expression toggle (=) off and enter the userKey. Returns all groups to which this user belongs.

Examples

The following tables provides sample:


ResourceFilter keyFilter valueResult
userPhotouserkey(expression toggle (=) off) user@example.comReturns the resource data for the user's photo.
user[None][None]Returns all users.
userdomain(expression toggle (=) off) example.comReturns all users within the specified domain.
usershowDeleted(expression toggle (=) off) trueReturns deleted users.
usercustomer(expression toggle (=) off)  my_customerReturns all users for the customer ID if the account is an account administrator.
userfields(expression toggle (=) off)  users(aliases,name,primaryEmail)Returns the name, primary email and email aliases for all users.
userquery(expression toggle (=) off) isAdmin=trueReturns all admins.
userquery(expression toggle (=) off) givenName:Tim*Returns all users whose givenName starts with Tim.
orgunitfields(expression toggle (=) off)  kind,name,orgUnitPathReturns kind,name,orgUnitPath fields of the orgunits.


See Also

Insert excerpt
Google Directory Snap Pack
Google Directory Snap Pack
nopaneltrue