Skip to main content

Google Workspace channel

See the Channel Catalog to see which Plans have access to this channel.

Google Workspace, formerly known as G Suite, is a collection of cloud computing, productivity and collaboration tools, software and products developed and marketed by Google.

How to Connect

  1. On the My pipelines page, select Create Pipeline.
  2. Search for or select a step, and then select it to add it to the pipeline.
    When you add a step to a pipeline, it is added to the canvas of the pipeline designer.
  3.  Expand the Connection section of the step, and add the required information.

For more information about connections, see How to connect to a channel.

Connect to Google Workspace

  1. Expand Google Workspace in the list of channels and click Connect to Google Workspace.
  2. Review the permissions that Pipelines will receive once connected. Your permissions are based on your existing Google account. You can select specific permissions or allow all the options. Google Workspace permissions are required. You may need to scroll down to see all your permission choices. When finished click Connect to Google Workspace.
  3. Sign in with your Google credentials and click Authorize.
  4. Agree to allow Pipelines access to your Google account by clicking Allow.

Note: Your functionality and integration may be different depending on your permissions.

How to reconnect

You may need to reconnect your account to a channel. Reasons may be (but not limited to):

  • If you need to connect a different account.
  • Authorization updates, such as a changed password.
  • Editing the access rights that Pipelines has to the channel.

To reconnect:

  1. Select a pipeline that already has this channel in it.
  2. Open a step that contains this channel.
  3. Under account, select Connect (or reconnect) and follow the process above, How to connect.

Steps

The steps you can use with Google Workspace are of three types: Groups, Users, and Group Members.

Note: You cannot use jinja expressions in trigger conditions unless explicitly specified as possible.

Type Name Description
Groups
Trigger Group Created Triggers when a group is created.
Trigger Group Updated Triggers when a group is updated.
Trigger Group Deleted Triggers when a group is deleted.
Action Create Group Creates a group for a selected account and specifics the group name and email.
Action Update Group Updates a group already specified in the pipeline.
Action Delete Group Deletes a group already specified in the pipeline.
Query Search Groups Searches for a group for a selected account. You can limit the number of results.
Action Fetch a Linked Group Fetches a linked group for a selected linked resource.
Users    
Trigger User Created Triggers when a user is created.
Trigger User Updated Triggers when a user is updated.
Trigger User Deleted Triggers when a user is deleted.
Action Create User Creates a user for a selected account and specifics the user name, email, and password criteria.
Action Update User Updates a user already specified in the pipeline.
Action Delete User Deletes a user already specified in the pipeline.
Query Search Users Searches for a user for a selected account. You can limit the number of results.
Action Fetch a Linked User Fetches a linked user from a resource you specify.
Action Look Up a User Looks for a user for a selected account based on specified query.
Group Members    
Trigger Group Member Created Triggers when a group member is created.
Trigger Group Member Updated Triggers when a group member is updated.
Trigger Group Member Deleted Triggers when a group member is deleted.
Action Add Member Creates a group member for a selected account and group and specifics the email and role.
Action Update Group Member Updates a group member already specified in the pipeline.
Action Remove Member Removed a group member already specified in the pipeline.
Query Search Group Member Searches for a group member for a selected account. You can limit the number of results.
Action Fetch a Linked Group Member Fetches a linked group member from a resource you specify.
Action Look Up a Group Member Looks for a group member for a selected account based on specified query.

User field values

These are the values for the user fields:

Field Data Type Value
Account String The Google Workplace account for the action.

Primary email

 String The user's primary email address. This property is required in a request to create a user account. This must be unique and cannot be an alias of another user.
First name String

Given Name - The first name.

Holds the given and family names of the user, and the read-only fullName value. The maximum number of charactersfor the first and last names is 60. In addition, name values support unicode/UTF-8 characters, and can contain spaces, letters (a-z), numbers (0-9), dashes (-), forward slashes (/), and periods (.).
Last name String

Family Name - The last name of the user.
Phone number String Phone Number

Password Hash

 String

If a hashFunction is specified, the password must be a valid hash key. The password hash base on the selected hash function, for example a SHA-1 hash string might look like: 2fd4e1c67a2d28fced849ee1bb76e7391b93eb12
Hash function String

Stores the hash format of the password property. We recommend sending the password property value as a base 16 bit hexadecimal-encoded hash value. Set the hashFunction values as either the SHA-1, MD5, or crypt hash format.

For more infomation, see Hash function

Suspended

 Boolean

Indicates if user is suspended.

Limits

There are no known limits that impact your use in pipelines.

Examples of usage

The following is an example of a use of Google Workspace in Pipelines.

Employee onboarding and user provisioning

A new employee record, created in our Quickbase app, triggers the creation of a new user in Google Workspace.

  1. A new employee's information is added in our Quickbase HR app.

  2. Our pipeline, triggered by this addition, creates a user account in Google Workspace using this data.

Related articles

Top