G Suite Admin

Getting Started with G Suite Admin

The G Suite Admin modules allow you to watch, list, create, update, retrieve, and delete users, roles, role assignments, and organizational units in your G Suite Admin account.

Prerequisites

  • A G Suite Admin account

In order to use G Suite Admin with Make, it is necessary to have a G Suite Admin account. If you do not have one, you can create a G Suite Admin account at https://gsuite.google.com.

Note

The module dialog fields that are displayed in bold (in the Make scenario, not in this documentation article) are mandatory!

Connecting G Suite Admin to Make

  1. Go to Make and open G Suite Admin module's Create a connection dialog.

    61f26e2b8c3bb.gif
  2. Click Continue.

  3. Select the account with which you want to establish the connection.

    61f26e2da2582.png
  4. Confirm the account by clicking Allow.

    61f26e2e8ddcb.png

The connection has been established.

User

Triggers when a new user is created.

Connection

Establish a connection to your G Suite Admin account.

Your Domain

Select the domain whose users you want to watch.

Query Search

Enter the search query. You can search the users with the following three attributes:

  • Field: Specifies the user attribute to search. For example, givenName.

  • Operator: Test is performed on this attribute. For example, contains a value..

  • Value: Specifies the content to test. For example, Andrew.

For more details, refer to the Search Query Documentation.

Projection

Select the subset to fetch the user details:

  • Basic: Do not include any custom fields for the user.

  • Custom: Include custom fields from schemas requested in customFieldMask.

  • Full: Include all fields associated with this user.

Custom Field Mask

Enter a comma-separated list of schema names.

Limit

The maximum number of users Make should return during one scenario execution cycle.

Retrieves a list of users in a domain.

Connection

Establish a connection to your G Suite Admin account.

Your Domain

Select the domain whose users you want to list.

Query Search

Enter the search query. You can search the users with the following three attributes:

  • Field: Specifies the user attribute to search. For example, givenName.

  • Operator: Test is performed on this attribute. For example, contains a value..

  • Value: Specifies the content to test. For example, Andrew.

For more details, refer to the Search Query Documentation.

Order By

Select the order in which you want to list the users:

  • Email

  • Family Name

  • Given Name

Projection

Select the subset to fetch the user details:

  • Basic: Do not include any custom fields for the user.

  • Custom: Include custom fields from schemas requested in customFieldMask.

  • Full: Include all fields associated with this user.

Custom Field Mask

Enter a comma-separated list of schema names.

Show Deleted

When selected, lists the users who are deleted.

Sort Oder

Select the order in which you list the users:

  • Ascending

  • Descending

View Type

Select the option to view the users:

  • Admin View

  • Domain View

Limit

The maximum number of users Make should return during one scenario execution cycle.

Gets the details of a user.

Connection

Establish a connection to your G Suite Admin account.

User ID

Select the User ID whose details you want to retrieve.

Projection

Select the subset to fetch the user details:

  • Basic: Do not include any custom fields for the user.

  • Custom: Include custom fields from schemas requested in customFieldMask.

  • Full: Include all fields associated with this user.

Custom Field Mask

Enter a comma-separated list of schema names.

View Type

Select the view:

  • Admin View

  • Domain View

Creates a new user.

Connection

Establish a connection to your G Suite Admin account.

First Name

Enter the first name of the user.

Last Name

Enter the last name of the user.

Password

Enter the password of the user.

Your Domain

Select the domain for the user.

Phones

Add the phone numbers of the user:

Phone Number

Enter the phone number.

Type

Select the phone number type.

Primary

Select whether this is the primary phone number of the user:

  • Yes

  • No

  • Not defined

Secondary Email

Add the secondary email address:

Email Address

Enter the email address.

Type

Select the email address type:

  • Home

  • Work

  • Other

Change Password at Next Login

When selected, it prompts the user to change the password when tried to login next time.

Updates an existing user.

Connection

Establish a connection to your G Suite Admin account.

User ID

Select the User ID you want to update.

First Name

Enter the first name of the user.

Last Name

Enter the last name of the user.

Password

Enter the password of the user.

Your Domain

Select the domain for the user.

Phones

Add the phone numbers of the user:

Phone Number

Enter the phone number.

Type

Select the phone number type.

Primary

Select whether this is the primary phone number of the user:

  • Yes

  • No

  • Not defined

Secondary Email

Add the secondary email address:

Email Address

Enter the email address.

Type

Select the email address type:

  • Home

  • Work

  • Other

Deletes a user.

Connection

Establish a connection to your G Suite Admin account.

User ID

Select the User ID of the user you want to delete.

Makes a user a super administrator.

Connection

Establish a connection to your G Suite Admin account.

User ID

Select the User ID of the user whom you make a super admin.

Organizational Unit

Retrieves a list of all organizational units for an account.

Connection

Establish a connection to your G Suite Admin account.

Path

Select the path whose organizational units you want to list.

Type

Select the type of organizational units you want to list:

  • All

  • Children

Limit

The maximum number of organizational units Make should return during one scenario execution cycle.

Gets the details of an organizational unit.

Connection

Establish a connection to your G Suite Admin account.

Get Organizational Unit

Select the method by which you want to retrieve the organizational units:

  • By Path

  • By ID

Organizational Unit Path

Select the organizational path whose organizational unit details you want to retrieve.

Creates a new organizational unit.

Connection

Establish a connection to your G Suite Admin account.

Name

Enter the name of the organizational unit.

Description

Enter the details of the organizational unit.

Parent Organizational Unit Path

Enter the path to the parent organizational unit if this organization is a subsidiary of any other organization.

Updates an existing organizational unit.

Connection

Establish a connection to your G Suite Admin account.

Get Organizational Path

Select the method by which you want to retrieve the organizational units:

  • By Path

  • By ID

Organizational Unit Path

Select the organizational path whose organizational unit details you want to update.

Name

Enter a new name for the organizational unit.

Description

Enter the details of the organizational unit.

Deletes an organizational unit.

Connection

Establish a connection to your G Suite Admin account.

Get Organizational Path

Select the method by which you want to retrieve the organizational units:

  • By Path

  • By ID

Organizational Unit Path

Select the organizational path whose organizational unit details you want to delete.

Role

Retrieves a list of all roles in a domain.

Connection

Establish a connection to your G Suite Admin account.

Limit

The maximum number of roles Make should return during one scenario execution cycle.

Gets the details of a role.

Connection

Establish a connection to your G Suite Admin account.

Role ID

Select the Role ID whose details you want to retrieve.

Creates a new role.

Connection

Establish a connection to your G Suite Admin account.

Role Name

Enter a name for the role.

Role Privileges

Add the permissions for the role:

Service ID

Select the service.

Privilege Name

Select the permission.

Role Description

Enter the details of the role.

Updates an existing role.

Connection

Establish a connection to your G Suite Admin account.

Role ID

Select the Role ID you want to update.

Role Name

Enter a name for the role.

Role Privileges

Add the permissions for the role:

Service ID

Select the service.

Privilege Name

Select the permission.

Role Description

Enter the details of the role.

Deletes a role.

Connection

Establish a connection to your G Suite Admin account.

Role ID

Select the Role ID you want to delete.

Role Assignment

Retrieves a list of all role assignments.

Connection

Establish a connection to your G Suite Admin account.

Search Role Assignments

Select the option to search the role assignments you want to list:

  • By User Email Name

  • By User ID

  • By Role ID

Your Domain

Select the domain whose role assignments you want to list.

Limit

The maximum number of role assignments Make should return during one scenario execution cycle.

Gets the details of a role assignment.

Connection

Establish a connection to your G Suite Admin account.

Role Assignment ID

Select the Role Assignment ID whose details you want to retrieve.

Assigns a user to a specific role.

Connection

Establish a connection to your G Suite Admin account.

Role ID

Select the Role ID which you want to assign to the user.

Assign To

Select the user to whom you want to assign the role.

Deletes a role assignment.

Connection

Establish a connection to your G Suite Admin account.

Role Assignment ID

Select the Role Assignment ID you want to delete.

Other

Retrieves a list of all privileges for a customer.

Connection

Establish a connection to your G Suite Admin account.

Limit

The maximum number of privileges Make should return during one scenario execution cycle.

Performs an arbitrary authorized API call.

Connection

Establish a connection to your G Suite Admin account.

URL

Enter a path relative to https://www.googleapis.com. For example: /admin/directory/v1/users

Method

Select the HTTP method you want to use:

GET

to retrieve information for an entry.

POST

to create a new entry.

PUT

to update/replace an existing entry.

PATCH

to make a partial entry update.

DELETE

to delete an entry.

Headers

Enter the desired request headers. You don't have to add authorization headers; we already did that for you.

Query String

Enter the request query string.

Body

Enter the body content for your API call.

The following API call returns all the users in the same domain from your G Suite Admin account:

URL:

/admin/directory/v1/users

Method:

GET

Query String: Key: domain Value: {{domain you want to retrieve users from}}

61f26e2f89538.png

Matches of the search can be found in the module's Output under Bundle > Body > users. In our example, 3 users were returned:

61f26e307dc54.png