G Suite Admin

Node: gSuiteAdmin · Full type: n8n-nodes-base.gSuiteAdmin · Version: 1

Credentials

gSuiteAdminOAuth2Api (alias: @gsuite)

CREDENTIAL @gsuite = gSuiteAdminOAuth2Api "My G Suite Admin"

Operations

Resource: device

get

Parameter	Type	Default	Details
deviceId	resourceLocator	{...}	required; modes: list, deviceId
projection	options	"basic"	required; basic, full

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
projection	options	"basic"	required; basic, full
includeChildOrgunits	boolean	false
filter	collection	{}	keys: orgUnitPath, query
sort	fixedCollection	{}	groups: sortRules

update

Parameter	Type	Default	Details
deviceId	resourceLocator	{...}	required; modes: list, deviceId
updateOptions	collection	{}	keys: orgUnitPath, annotatedUser, annotatedLocation, annotatedAssetId, notes

changeStatus

Parameter	Type	Default	Details
deviceId	resourceLocator	{...}	required; modes: list, deviceId
action	options	"reenable"	required; reenable, disable

Resource: group

create

Parameter	Type	Default	Details
name	string	""
email	string	""	required
additionalFields	collection	{}	keys: description

delete

Parameter	Type	Default	Details
groupId	resourceLocator	{...}	required; modes: list, GroupId

get

Parameter	Type	Default	Details
groupId	resourceLocator	{...}	required; modes: list, GroupId

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
filter	collection	{}	keys: customer, domain, query, userId
sort	fixedCollection	{}	groups: sortRules

update

Parameter	Type	Default	Details
groupId	resourceLocator	{...}	required; modes: list, GroupId
updateFields	collection	{}	keys: description, email, name

Resource: user

addToGroup

Parameter	Type	Default	Details
userId	resourceLocator	{...}	required; modes: list, userEmail, userId
groupId	resourceLocator	{...}	required; modes: list, groupId

create

Parameter	Type	Default	Details
firstName	string	""	required
lastName	string	""	required
password	string	""	required
username	string	""
domain	options	""	required
additionalFields	collection	{}	keys: changePasswordAtNextLogin, phoneUi, emailUi, roles, customFields

delete

Parameter	Type	Default	Details
userId	resourceLocator	{...}	required; modes: list, userEmail, userId

get

Parameter	Type	Default	Details
userId	resourceLocator	{...}	required; modes: list, userEmail, userId
output	options	"simplified"	required; simplified, raw, select
fields	multiOptions	[]	multi: creationTime, isAdmin, kind, lastLoginTime, name, primaryEmail, suspended
projection	options	"basic"	required; basic, custom, full
customFieldMask	multiOptions	[]	required

getAll

Parameter	Type	Default	Details
returnAll	boolean	false
limit	number	100
output	options	"simplified"	required; simplified, raw, select
fields	multiOptions	[]	multi: creationTime, isAdmin, kind, lastLoginTime, name, primaryEmail, suspended
projection	options	"basic"	required; basic, custom, full
customFieldMask	multiOptions	[]	required
filter	collection	{}	keys: customer, domain, query, showDeleted
sort	fixedCollection	{}	groups: sortRules

removeFromGroup

Parameter	Type	Default	Details
userId	resourceLocator	{...}	required; modes: list, userEmail, userId
groupId	resourceLocator	{...}	required; modes: list, groupId

update

Parameter	Type	Default	Details
userId	resourceLocator	{...}	required; modes: list, userEmail, userId
updateFields	collection	{}	keys: archived, suspendUi, changePasswordAtNextLogin, firstName, lastName, password, ...

Parameter Details

updateOptions children:

Parameter	Type	Default	Details
orgUnitPath	options	[]
annotatedUser	string	""
annotatedLocation	string	""
annotatedAssetId	string	""
notes	string	""

filter children:

Parameter	Type	Default	Details
orgUnitPath	options	[]
query	string	""

sort children:

sortRules group:

Parameter	Type	Default	Details
orderBy	options	""	annotatedLocation, annotatedUser, lastSync, notes, serialNumber, status
sortBy	options	""	ascending, descending

updateFields children:

Parameter	Type	Default	Details
description	string	""
email	string	""
name	string	""

additionalFields children:

Parameter	Type	Default	Details
description	string	""

Example

NODE "gSuiteAdmin" @gsuite AS "G Suite Admin" {
  resource: "device",
  operation: "get",
  email: {{ $json.email }},
  firstName: {{ $json.firstName }},
  lastName: {{ $json.lastName }}
}