Connectors / Service / G-Suite

The G Suite connector allows to manage everything in your Google G Suite domain. (updated: 1657718034907)

G-Suite

Collaboration & Productivity Apps for Business

Overview

The Tray.io G Suite connector allows you to manage your organisation in G Suite.

Authentication

Note: Before authenticating this Google connector, you will need to whitelist the Tray.io Google authentication app. Please follow the instructions here before continuing with the authentication process.

Once this is done, you can click on the New Authentication button:

g-suite-auth

Check every scope to allow Tray the correct permissions, then proceed to log in to your G Suite account.

Available Operations

The examples below show one or two of the available connector operations in use.

Please see the Full Operations Reference at the end of this page for details on all available operations for this connector.

Example

In the following example we create a workflow that retrieves a list of users and assigns one of the users to a group.

To begin with, create a workflow with a Manual Trigger, then add a step from the G Suite connector with the operation set to List Users. Set the 'Customer' parameter to "my_customer", this is a keyword that specifies your own account. This will output a list of users:

g-suite-list-users

Next, we add a step from the G Suite connector with the operation set to Get user, to retrieve one of the users from the list. Set the User key to the ID of one of the users, by using a JsonPath as shown in the example:

g-suite-get-users

Then, we add a step with the operation set to List groups, enter the domain associated with our account, and in the output we retrieve a list of groups in our account:

g-suite-list-groups

We use the output of this step to find the ID of a group. We add another step with the operation set to Add member to group, set the Group key to the id of one of the groups, and the User key to the primaryEmail of the user we returned in Get user:

g-suite-add-member

Finally, we use the Check group membership operation to verify the membership, setting the Group key as above, and setting the Member key to the primaryEmail of the user, as in the User key above. The operation should return isMember: true in the output:

g-suite-check-group-membership

All Operations

Latest version:

2.1

Add member to group

Adds a user to the specified group.

Check group membership

Checks whether the given user is a member of the group. Membership can be direct or nested.

Create data transfer

Creates a data transfer request.

Create group

Creates a group.

Create organisational unit

Adds an organizational unit.

Create role

Creates a role.

Create role

Creates a role.

Create role assignment

Creates a role assignment.

Create schema

Create schema.

Create shared contact

Create a new shared contact

Create user

Creates a user.

Delete group

Deletes a group.

Delete group membership

Removes a member from a group.

Delete organisational unit

Deletes an organizational unit.

Delete role

Deletes a role.

Delete shared contact

Delete shared contact using their ID

Delete user

Deletes a user.

Get application

Get application by ID

Get custom schema

Retrieve schema.

Get data transfer

Get data transfer by ID

Get group

Retrieves a group.

Get group member

Retrieves a group member's properties.

Get organisational unit

Retrieves an organizational unit.

Get role

Retrieves a role.

Get schema

Retrieve schema.

Get shared contact

Retrieve a shared contact using their ID

Get user

Retrieves a user.

List applications

Lists the applications available for data transfer for a customer.

List custom schemas

Retrieve all schemas for a customer.

List data transfers

Lists the transfers for a customer by source user, destination user, or status.

List group members

Retrieves a paginated list of all members in a group.

List groups

Retrieve all groups of a domain or of a user given a userKey (paginated).

List organisational units

Retrieves a list of all organizational units for an account.

List organisational units DDL

List roles

Retrieves a paginated list of all the roles in a domain.

List roles DDL

List shared contacts

Retrieve all of a user's contacts

List users

Retrieves a paginated list of either deleted users or all users in a domain.

Update group

Updates a group. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Update group membership

Updates the membership properties of a user in the specified group. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Update organisational unit

Updates an organizational unit. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Update schema

Updates a schema. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Update shared contact

Update shared shared contact

Update user

Updates a user. Fields that are not present in the request will be preserved, and fields set to null will be cleared.