X

Actions

Home > Application Reference > G Suite Admin

Jump to a Section

Overview

Authorizing an Account

The first time that you add a G Suite Admin card to a Flow, you will prompted to create a connection. Connecting your account will enable you to save your account information and reuse that connection the next time you build a Flow with the connector. Note that you can create multiple connections and share them with your team.

  1. On the Settings page, click +New Connection. Or, if you’ve already stared a new Flow, you’ll be prompted to enter a new connection when you select your G Suite Admin action.
  2. Enter an Account Nickname. As a best practice, make this nickname unique so that you can connect multiple G Suite Admin accounts.
  3. Enter your Domain.
  4. Click Create.

    Actions

    • Add Address to User

      Add an address to G Suite user.

      Unless otherwise indicated, all field types are text.

      Input

      • User

        • User ID: unique identifier of the user

      • Address

        • Street: street portion of the user’s address
        • PO Box: user’s post office box
        • City: user’s city of residence
        • Region: user’s geographic region
        • Postal Code: zip or postal code of the user’s address
        • Country: user’s country of residence
        • Country Code: telephone prefix for user’s country of residence (ISO 3166-1 standard)
        • Extended Address: extended fields for addresses that includes a sub-region
        • Formatted Address: formatted version of the address
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if address type selection is custom
        • Primary? (true/false): indicator if this is the user’s primary address

    • Add Email to User

      Add email details to a G Suite user.

      Input

      • User

        • User ID: unique identifier of the user

      • Email

        • Email Address: email address of the user
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if email address type selection is custom
        • Primary? (true/false): indicator if this is the user’s primary email address

    • Add External ID to User

      Add an External ID to a G Suite user.

      Unless otherwise indicated, field types are text.

      Input

      • User
        • User ID: unique identifier of the user
      • External ID
        • Extenal ID: value of the ID
        • Type (option): type of external ID
          • account
          • custom
          • customer
          • login_ID
          • network
          • organization
        • Custom Type: required, user-defined value if address type selection is custom

    • Add IM to User

      Add an Instant Messenger (IM) account to a G Suite user.

      Input

      • User
        • User ID (text): unique identifier of the user
      • IM
        • IM Network ID: user’s IM accounts (user may have multiple IM accounts but only one primary)
        • Type: IM account type
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if IM type is custom
        • Protocol (option): IM network (custom network or standard network)
        • Custom Protocol: required, user defined value if the protocol is custom
        • Primary (boolean): indicator if this is the user’s primary IM

    • Add Organization to User

      Add Organization details to a G Suite user.

      Unless otherwise indicated, field types are text.

      Input

      • User
        • User ID: unique identifier of the user
      • Organization
        • Organization Name: name of the organization
        • Description: description of the organization
        • Department: department in the organization that the user is associated with (for example, sales or engineering)
        • Job Title: user’s title in the organization (for example, member or engineer)
        • Location: physical location of the organization (this is not required to be an address)
        • Symbol: text string symbol of the organization (for example, Google’s symbol is GOOG)
        • Cost Center: cost center of the user’s organization
        • Domain: domain that the organization belongs to
        • Type: type of organization
        • Primary (boolean): indicator if this is the user’s primary organization

    • Add Phone to User

      Add a phone contact to a G Suite user.

      Unless otherwise indicated, field types are text.

      Input

      • User
        • User ID: unique identifier of the user
      • Phone
        • Phone Number: human-readable phone number (any telephone number format)
        • Type: type of phone number
          • assistant
          • callback
          • car
          • company_main
          • custom
          • grand_central
          • home
          • home_fax
          • isdn
          • main
          • mobile
          • other
          • other_fax
          • pager
          • radio
          • telex
          • tty_ttd
          • work
          • work_fax
          • work_mobile
          • work_pager
        • Custom Type: required, user defined value if the type is custom
        • Primary? (boolean): indicator if this is the user’s primary phone number

    • Add Relation to User

      Add a relation to a G Suite user.

      All field types are text.

      Input

      • User
        • User ID: unique identifier of the user
      • Relation
        • Relation Name: name of the person the user is related to
        • Type: type of relation
          • admin_assistant
          • assistant
          • brother
          • child
          • custom
          • domestic_partner
          • dotted_line_manager
          • exec_assistant
          • father
          • friend
          • manager
          • mother
          • parent
          • partner
          • referred_by
          • relative
          • sister
          • spouse
        • Custom Type: required, user defined value if the type is custom

    • Add User to Group

      Add a user to a group in G Suite.

      All field types are text.

      Input

      • User
        • Email Address: user’s primary email address (must be unique and cannot be an alias)
        • Role: user’s role (Manager, Member, or Owner)
      • Group
        • Group Key: unique identifier for the default group

    • Add Website to User

      Add a website to a G Suite user’s profile.

      Unless otherwise indicated, field types are text.

      Input

      • User
        • User ID: unique identifier of the user
      • Website
        • Website URL: URL of the website
        • Type: type or purpose of the website
          • app_install_page
          • blog
          • custom
          • ftp
          • home
          • home_page
          • other
          • profile
          • reservations
          • resume
          • work
        • Custom Type: required, user defined value if website type is custom
        • Primary (boolean): indicator if this is the user’s primary website

    • Assign License to User

      Assign a license to G Suite user.

      For more information visit Google’s license documentation page.

      Input

      • Product
        • Licenses (list of objects): list of product licenses (or single license) that you want to assign to the user
      • User
        • Primary Email (text): email address of the user to whom you want to assign licenses

    • Create Custom Schema

      Use schemas to add custom fields to user profiles. You can use these fields to store information such as the projects your users work on, their physical locations, or their hire dates. For more information, refer to the Google API document.

      Input

      • Schema
        • Schema Name (string): schema’s name
        • Custom Fields (object): list of fields in the schema

    • Create User

      Create user in G Suite.

      For more information, refer to the Google API document

      Unless otherwise indicated, field types are text.

      Input

      • User
        • First Name: user’s first name
        • Last Name: user’s last name
        • Primary Email: user’s primary email address (must be unique and cannot be an alias of another user)
        • Notes: notes for the user
        • Is Admin? (boolean): indicator if the user has super admininistrator privileges (this field can only be edited in the Make a User an Administrator action)
        • Is Delegated Admin? (boolean): indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.
        • Included in Global Address List? (boolean): indicator if the user’s profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.
        • Password: password for the user account (password requirements: minimum 8 charatcers, maximum 100 characters, may contain any combination of ASCII characters). We recommend sending the password property value as a base 16 bit, hexidecimal-encoded hash value. If a hashFunction is specified, the password must be a valid hash key. The password value is never returned in the API’s response body.
        • Change Password At Next Login? (boolean): indicator if the user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider)
        • IP Whitelisted? (boolean): indicator if the user’s IP address is white listed
        • Alias: alias email address
      • IM
        • IM Network ID: user’s IM accounts (user may have multiple IM accounts but only one primary)
        • Type: IM account type
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if IM type is custom
        • Protocol (option): IM network (custom network or standard network)
        • Custom Protocol: required, user defined value if the protocol is custom
        • Primary (boolean): indicator if this is the user’s primary IM
      • Email
        • Address: email address of the user
        • Primary? (boolean): indicator if this is the user’s primary email address
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if email address type selection is custom
      • External ID
        • Extenal ID: value of the ID
        • Type (option): type of external ID
          • account
          • custom
          • customer
          • login_ID
          • network
          • organization
        • Custom Type: required, user defined value if address type selection is custom
      • Relation
        • Relation Name: name of the person the user is related to
        • Type: type of relation
          • admin_assistant
          • assistant
          • brother
          • child
          • custom
          • domestic_partner
          • dotted_line_manager
          • exec_assistant
          • father
          • friend
          • manager
          • mother
          • parent
          • partner
          • referred_by
          • relative
          • sister
          • spouse
        • Custom Type: required, user defined value if type is custom
      • Address
        • Street: street portion of the user’s address
        • PO Box: user’s post office box
        • City: user’s city of residence
        • Region: user’s geographic region
        • Postal Code: zip or postal code of the user’s address
        • Country: user’s country of residence
        • Country Code: telephone prefix for user’s country of residence (ISO 3166-1 standard)
        • Extended Address: extended fields for addresses that includes a sub-region
        • Formatted Address: formatted version of the address
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if address type selection is custom
        • Primary? (true/false): indicator if this is the user’s primary address
      • Organization
        • Organization Name: name of the organization
        • Description: description of the organization
        • Department: department in the organization that the user is associated with (for example, sales or engineering)
        • Job Title: user’s title in the organization (for example, member or engineer)
        • Location: physical location of the organization (this is not required to be an address)
        • Symbol: text string symbol of the organization (for example, Google’s symbol is GOOG)
        • Cost Center: cost center of the user’s organization
        • Domain: domain that the organization belongs to
        • Type: type of organization
        • Primary (boolean): indicator if this is the user’s primary organization
      • Phone
        • Phone Number: human-readable phone number (any telephone number format)
        • Type: type of phone number
          • assistant
          • callback
          • car
          • company_main
          • custom
          • grand_central
          • home
          • home_fax
          • isdn
          • main
          • mobile
          • other
          • other_fax
          • pager
          • radio
          • telex
          • tty_ttd
          • work
          • work_fax
          • work_mobile
          • work_pager
        • Custom Type: required, user defined value if the type is custom
        • Primary? (boolean): indicator if this is the user’s primary phone number
      • Website
        • Website URL : URL of the website
        • Type: type or purpose of the website
          • app_install_page
          • blog
          • custom
          • ftp
          • home
          • home_page
          • other
          • profile
          • reservations
          • resume
          • work
        • Custom Type: required, user defined value if website type is custom
        • Primary (boolean): indicator if this is the user’s primary website
      • Product
        • Licenses (list of object): product licenses that you want to assign to the user

    • Create user alias

      Create a user alias in G Suite.

      Field types are text.

      Input

      • User ID
        • ID: unique identifier of the user
      • Alias
        • Alias: unique alias of the user

    • Delete user

      Delete a user in G Suite.

      Field type is text.

      Input

      • Delete By
        • User ID: unique identifier of the user to be deleted

    • Delete User Alias

      Delete a user alias in G Suite.

      Field types are text.

      Input

      • User ID
        • ID: unique identifier of the user
      • Alias
        • Alias: unique alias to be deleted

    • Get All Licenses

      Get all available G Suite user licenses. For more information, refer to the Google documentation.

      Field types are text.

      Output

      • Licenses
        • name: license name
        • productid: unique identifier of product
        • skuid: unique identifier of the Google SKU

    • Make User Admin

      Change a user’s privilige to Admin in G Suite.

      Field type is text.

      Input

      • Make Admin By
        • User ID: unique identifier of the user

    • Read User

      Retrieve details of a user in G Suite.

      Unless otherwise indicated, field types are text.

      Input

      • Read By
        • User ID: unique identifier of the user

      Output

      • User
        • First Name: user’s first name
        • Last Name: user’s last name
        • Primary Email: user’s primary email address (must be unique and cannot be an alias of another user)
        • Notes: notes for the user
        • Is Admin? (boolean): indicator if the user has super admininistrator privileges (this field can only be edited in the Make a User an Administrator action)
        • Is Delegated Admin? (boolean): An indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.
        • Included in Global Address List? (boolean): indicator if the user’s profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.
        • Password: password for the user account (password requirements: minimum 8 charatcers, maximum 100 characters, may contain any combination of ASCII characters). We recommend sending the password property value as a base 16 bit, hexidecimal-encoded hash value. If a hashFunction is specified, the password must be a valid hash key. The password value is never returned in the API’s response body.
        • Change Password At Next Login? (boolean): indicator if the user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider)
        • IP Whitelisted? (boolean): indicator if the user’s IP address is white listed
        • Alias: alias email address
      • IM
        • IM Network ID: user’s IM accounts (user may have multiple IM accounts but only one primary)
        • Type: IM account type
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if IM type is custom
        • Protocol (option): IM network (custom network or standard network)
        • Custom Protocol: required, user defined value if the protocol is custom
        • Primary (boolean): indicator if this is the user’s primary IM
      • Email
        • Address: email address of the user
        • Primary? (boolean): indicator if this is the user’s primary email address
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if email address type selection is custom
      • External ID
        • Extenal ID: value of the ID
        • Type (option): type of external ID
          • account
          • custom
          • customer
          • login_ID
          • network
          • organization
        • Custom Type: required, user defined value if address type selection is custom
      • Relation
        • Relation Name: name of the person the user is related to
        • Type: type of relation
          • admin_assistant
          • assistant
          • brother
          • child
          • custom
          • domestic_partner
          • dotted_line_manager
          • exec_assistant
          • father
          • friend
          • manager
          • mother
          • parent
          • partner
          • referred_by
          • relative
          • sister
          • spouse
        • Custom Type: required, user defined value if type is custom
      • Address
        • Street: street portion of the user’s address
        • PO Box: user’s post office box
        • City: user’s city of residence
        • Region: user’s geographic region
        • Postal Code: zip or postal code of the user’s address
        • Country: user’s country of residence
        • Country Code: telephone prefix for user’s country of residence (ISO 3166-1 standard)
        • Extended Address: extended fields for addresses that includes a sub-region
        • Formatted Address: formatted version of the address
        • Type (drop-down)
          • home
          • work
          • custom
          • other
        • Custom Type: required, user defined value if address type selection is custom
        • Primary? (true/false): indicator if this is the user’s primary address
      • Organization
        • Organization Name: name of the organization
        • Description: description of the organization
        • Department: department in the organization that the user is associated with (for example, sales or engineering)
        • Job Title: user’s title in the organization (for example, member or engineer)
        • Location: physical location of the organization (this is not required to be an address)
        • Symbol: text string symbol of the organization (for example, Google’s symbol is GOOG)
        • Cost Center: cost center of the user’s organization
        • Domain: domain that the organization belongs to
        • Type: type of organization
        • Primary (boolean): indicator if this is the user’s primary organization
      • Phone
        • Phone Number: human-readable phone number (any telephone number format)
        • Type: type of phone number
          • assistant
          • callback
          • car
          • company_main
          • custom
          • grand_central
          • home
          • home_fax
          • isdn
          • main
          • mobile
          • other
          • other_fax
          • pager
          • radio
          • telex
          • tty_ttd
          • work
          • work_fax
          • work_mobile
          • work_pager
        • Custom Type: required, user defined value if the type is custom
        • Primary? (boolean): indicator if this is the user’s primary phone number
      • Website
        • Website URL : URL of the website
        • Type: type or purpose of the website
          • app_install_page
          • blog
          • custom
          • ftp
          • home
          • home_page
          • other
          • profile
          • reservations
          • resume
          • work
        • Custom Type: required, user defined value if website type is custom
        • Primary (boolean): indicator if this is the user’s primary website
      • Product
        • Licenses (list of object): product licenses that you want to assign to the user

    • Read User Alias

      Retrieve a user alias in G Suite.

      Unless otherwise indicated, field types are text.

      Input

      • User ID
        • ID: unique identifier of the user

      Output

      • Response
        • Kind: API resource
        • eTag: eTag resource
        • Aliases (drop-down): list of aliases

    • Read User Licenses

      Retrieve all licenses for a user.

      Input

      • User
        • ID (text): unique identifier of the user

      Output

      • User
        • Licenses (list of objects): product licenses assigned to the user

    • Remove User From Group

      Remove user from a group in G Suite.

      Field types are text.

      Input

      • User

        • Email Address: email address of the user

      • Group

        • Group Key: unique identifier of the group you want the user removed from

      Input

      • User
        • Email Address: email address of the user
      • Group
        • Group Key: unique identifier of the group you want the user removed from

    • Search User

      Search for a user in G Suite.

      Unless otherwise indicated, field types are text.

      Options

      • Return
        • First matching user: first user record to match search criteria
        • All matching users: all user records that match search criteria

      Search By

      • User
        • Name: name of the user
        • Email: email address of the user
        • First Name: user’s first name
        • Last Name: user’s last name
        • Primary Email: user’s primary email address (must be unique and cannot be an alias of another user)
        • Notes: notes for the user
        • Is Admin? (boolean): indicator if the user has super admininistrator privileges (this field can only be edited in the Make User Admin action)
        • Is Delegated Admin? (boolean): indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.
        • IM Network ID: user’s IM accounts (user may have multiple IM accounts, but only one primary)
        • Extenal ID: value of the ID
        • Manager Email: email address of the user’s manager
        • Direct Manager Email: email address of the user’s direct manager
        • Direct Manager ID: unique identifier of the user’s direct manager
        • Address: user’s address
        • Street: street portion of the user’s address
        • PO Box: user’s post office box
        • City: user’s city of residence
        • Region: user’s geographic region
        • Postal Code: zip or postal code of the user’s address
        • Country: user’s country of residence
        • Organization Name: name of the organization
        • Department: department in the organization that the user is associated with (for example, sales or engineering)
        • Description: description of the organization
        • Cost Center: cost center of the user’s organization
        • Phone: phone number of the organization
        • Parent Organization Path: full path of the parent organization associated with the user (if the parent organization is the top-level, it is represented as a forward slash)
        • Is Enrolled in 2SV? (boolean): indicator if user enrolled in 2-step verification
        • Is Enforced in 2SV? (boolean): indicator if user is 2-step verification enforced
        • Custom Schema Name: custom schema for the user
        • Custom Field Name: custom fields for the user

    • Unassign License From User

      Unassign licenses from a user in G Suite.

      For more information visit Google’s license documentation page.

      Field types are text.

      Input

      • Product
        • Licenses: product licenses to be unassigned
      • User
        • Primary Email: email address of the user

    • Update User

      Update a user in G Suite.

      Unless otherwise indicated, field types are text.

      Input

      • Update By
        • User ID: unique identifier of the user
      • User
        • First Name: user’s first name
        • Last Name: user’s last name
        • Primary Email: user’s primary email address (must be unique and cannot be an alias of another user)
        • Notes: notes for the user
        • Is Admin? (boolean): indicator if the user has super admininistrator privileges (this field can only be edited in the Make User Admin action)
        • Is Delegated Admin? (boolean): indicator if the user is a delegated administrator. Delegated administrators are supported by the API but cannot create or undelete users, or make users administrators. These requests are ignored by the API service. Roles and privileges for administrators are assigned using the Admin console.
        • Included in Global Address List? (boolean): indicator if the user’s profile is visible in the G Suite global address list when the contact sharing feature is enabled for the domain. For more information about excluding user profiles, see the administration help center.
        • Password: password for the user account (password requirements: minimum 8 charatcers, maximum 100 characters, may contain any combination of ASCII characters). Storing the user’s password is optional when updating a user and should only be provided if the user is updating their account password. We recommend sending the password property value as a base 16 bit, hexidecimal-encoded hash value. If a hashFunction is specified, the password must be a valid hash key. The password value is never returned in the API’s response body.
        • Change Password At Next Login? (boolean): indicator if the user is forced to change their password at next login (does not apply when SSO is configured with a third party identity provider)
        • IP Whitelisted? (boolean): indicator if the user’s IP address is white listed
        • Alias: user’s alias email address