Google Workspace Admin

App · 26 actions

Manage Google Workspace users, groups, group membership and organizational units.

Actions

ActionWhat it does
Add group memberAdd a person, or another group, to a Google Workspace group as a member, manager or owner.
Create groupCreate a Google Workspace group with an email address, a name and a description.
Create organizational unitCreate an organizational unit inside another one, for example West inside /Sales.
Create userCreate a Google Workspace account for a new person, with their name, sign-in email address and password.
Create user aliasGive a person an extra email address (an alias) that delivers to their mailbox.
Delete groupDelete a Google Workspace group.
Delete userDelete a person's Google Workspace account.
Get groupLook up one Google Workspace group by email address or ID, with its name, description and member count.
Get group memberLook up one member of a Google Workspace group, with their role and how they receive the group's email.
Get organizational unitLook up one organizational unit by its path, with its name, description and parent unit.
Get userLook up one person in your Google Workspace by email address or ID, with their name, last sign-in, organizational unit and whether they are suspended or an administrator.
List admin rolesList the administrator roles defined in your Google Workspace, one page at a time, each with its name and what it allows.
List domainsList the domains your Google Workspace owns, such as acme.com, saying which is the primary one and which are verified.
List group aliasesList the extra email addresses (aliases) that deliver to a group.
List group membersList the people and groups that belong to a Google Workspace group, one page at a time, each with their email address and role.
List groupsList the groups in your Google Workspace, or only the groups one person belongs to, one page at a time, each with its name, email address and member count.
List organizational unitsList the organizational units (the folders people are sorted into, such as /Sales) in your Google Workspace, each with its name and full path.
List user aliasesList the extra email addresses (aliases) that deliver to one person's mailbox.
List usersList the people in your Google Workspace, one page at a time (up to 500 a page), each with their name, email, last sign-in and whether they are suspended.
List users who haven't signed inBeta.
Remove group memberRemove a person or group from a Google Workspace group.
Restore userBring back a Google Workspace account deleted in the last 20 days, into the organizational unit you name.
Sign out userSign a person out of every device and browser where they are signed in to their Google Workspace account.
Update groupChange a Google Workspace group's name, description or email address.
Update group memberChange a group member's role or how they receive the group's email.
Update userChange a person's Google Workspace account: their name, email address, password, organizational unit, or suspend or restore them.

Add group member

Add a person, or another group, to a Google Workspace group as a member, manager or owner.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Delivery settingsdelivery_settingstext
How the member receives the group's email: ALL_MAIL (every message as it arrives), DAILY (at most one message a day), DIGEST (up to 25 messages bundled into one), DISABLED (unsubscribed) or NONE (no email). Leave blank for every message.One of: ALL_MAIL, DAILY, DIGEST, DISABLED, NONE.
RoleroletextRequired
The role to give them in the group: MEMBER, MANAGER or OWNER.One of: MEMBER, MANAGER, OWNER.
EmailemailtextRequired
The email address of the person or group to add, for example jane@acme.com.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "delivery_settings": "example",
    "email": "example",
    "etag": "example",
    "id": "example",
    "kind": "example",
    "role": "example",
    "status": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create group

Create a Google Workspace group with an email address, a name and a description.

Inputs

Admin createdadmin_createdtrue/false
Leave blank. Google records for itself whether an administrator created the group.
EmailemailtextRequired
The group's email address, on one of your domains, for example sales@acme.com.
Descriptiondescriptiontext
A sentence or two saying what the group is for.
Namenametext
The group's name as people see it, for example Sales Team.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "adminCreated": false,
    "aliases": [],
    "description": "example",
    "directMembersCount": "example",
    "email": "example",
    "etag": "example",
    "externalIds": [],
    "id": "example",
    "kind": "example",
    "name": "example",
    "nonEditableAliases": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Create organizational unit

Create an organizational unit inside another one, for example West inside /Sales.

Inputs

Customer IDcustomer_idtext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.
Descriptiondescriptiontext
A sentence saying what the organizational unit is for.
NamenametextRequired
The new unit's name, for example West. It becomes the last part of its path (/Sales/West).
Block inheritanceblock_inheritancetrue/false
Leave blank. Google no longer lets a unit block the settings it inherits.
Parent org unit pathparent_org_unit_pathtext
The full path of the unit to create this one inside, for example /Sales. Use / for the top level.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "blockInheritance": false,
    "description": "example",
    "etag": "example",
    "kind": "example",
    "name": "example",
    "orgUnitId": "example",
    "orgUnitPath": "example",
    "parentOrgUnitId": "example",
    "parentOrgUnitPath": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create user

Create a Google Workspace account for a new person, with their name, sign-in email address and password.

Inputs

Resolve conflict accountresolve_conflict_accounttrue/false
Turn on to apply your organization's setting for conflicting accounts when a personal Google account already uses this email address.
Recovery emailrecovery_emailtext
A personal email address the person can use to get back into their account, for example jane@gmail.com.
PasswordpasswordtextRequired
The account's password, 8 to 100 characters.
Primary emailprimary_emailtextRequired
The person's sign-in email address, on one of your domains, for example jane@acme.com.
Suspendedsuspendedtrue/false
Turn on to create the account suspended, so the person cannot sign in yet.
Change password at next loginchange_password_at_next_logintrue/false
Turn on to make the person choose a new password the first time they sign in.
Org unit pathorg_unit_pathtext
The organizational unit to put the person in, as its full path, for example /Sales/West. Leave blank for the top level (/).
Given namegiven_nametextRequired
The person's first name.
Family namefamily_nametextRequired
The person's last name.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "addresses": "example",
    "agreedToTerms": false,
    "aliases": [],
    "archivalTime": "example",
    "archived": false,
    "changePasswordAtNextLogin": false,
    "creationTime": "2026-01-01T00:00:00Z",
    "customSchemas": {},
    "customerId": "example",
    "deletionTime": "2026-01-01T00:00:00Z",
    "emails": "example",
    "etag": "example",
    "externalIds": "example",
    "gender": "example",
    "guestAccountInfo": {
      "primaryGuestEmail": "example"
    },
    "id": "example",
    "ims": "example",
    "includeInGlobalAddressList": false,
    "ipWhitelisted": false,
    "isAdmin": false,
    "isDelegatedAdmin": false,
    "isEnforcedIn2Sv": false,
    "isEnrolledIn2Sv": false,
    "isGuestUser": false,
    "isMailboxSetup": false,
    "keywords": "example",
    "kind": "example",
    "languages": "example",
    "lastLoginTime": "2026-01-01T00:00:00Z",
    "locations": "example",
    "name": {
      "displayName": "example",
      "familyName": "example",
      "fullName": "example",
      "givenName": "example"
    },
    "nonEditableAliases": [],
    "notes": "example",
    "orgUnitPath": "example",
    "organizations": "example",
    "phones": "example",
    "posixAccounts": "example",
    "primaryEmail": "example",
    "recoveryEmail": "example",
    "recoveryPhone": "example",
    "relations": "example",
    "sshPublicKeys": "example",
    "suspended": false,
    "suspensionReason": "example",
    "suspensionTime": "example",
    "thumbnailPhotoEtag": "example",
    "thumbnailPhotoUrl": "example",
    "websites": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Create user alias

Give a person an extra email address (an alias) that delivers to their mailbox.

Inputs

User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
Primary emailprimary_emailtext
Leave blank. Google fills in the person's primary email address.
Etagetagtext
Leave blank. Google's own version marker for the record.
AliasaliastextRequired
The extra email address to give the person, on one of your domains, for example j.smith@acme.com.
Ididtext
Leave blank. Google fills in the person's ID.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "alias": "example",
    "etag": "example",
    "id": "example",
    "kind": "example",
    "primaryEmail": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Delete group

Delete a Google Workspace group. Its members keep their accounts.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

Outputs

datanull
Empty: Google sends nothing back when this succeeds.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Delete user

Delete a person's Google Workspace account. It can be restored for 20 days with Restore user.

Inputs

User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

Outputs

datanull
Empty: Google sends nothing back when this succeeds.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Get group

Look up one Google Workspace group by email address or ID, with its name, description and member count.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "adminCreated": false,
    "aliases": [],
    "description": "example",
    "directMembersCount": "example",
    "email": "example",
    "etag": "example",
    "externalIds": [],
    "id": "example",
    "kind": "example",
    "name": "example",
    "nonEditableAliases": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Get group member

Look up one member of a Google Workspace group, with their role and how they receive the group's email.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Member keymember_keytextRequired
The member: their email address (jane@acme.com) or Google ID.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "delivery_settings": "example",
    "email": "example",
    "etag": "example",
    "id": "example",
    "kind": "example",
    "role": "example",
    "status": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get organizational unit

Look up one organizational unit by its path, with its name, description and parent unit.

Inputs

Customer IDcustomer_idtext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.
Org unit pathorg_unit_pathtextRequired
The organizational unit's full path, for example /Sales/West.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "blockInheritance": false,
    "description": "example",
    "etag": "example",
    "kind": "example",
    "name": "example",
    "orgUnitId": "example",
    "orgUnitPath": "example",
    "parentOrgUnitId": "example",
    "parentOrgUnitPath": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Get user

Look up one person in your Google Workspace by email address or ID, with their name, last sign-in, organizational unit and whether they are suspended or an administrator.

Inputs

Custom field maskcustom_field_masktext
Which custom fields to include, as custom schema names separated by commas, for example Employment,Badges. Leave blank for the standard fields.
User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "addresses": [],
    "agreedToTerms": false,
    "aliases": [],
    "archivalTime": "",
    "archived": false,
    "changePasswordAtNextLogin": false,
    "created": "2024-02-19",
    "created_display": "Feb 19, 2024",
    "creationTime": "2024-02-19T09:30:00.000Z",
    "customSchemas": {},
    "customerId": "C03az79cb",
    "days_since_sign_in": 100,
    "deletionTime": "",
    "email": "jane@acme.com",
    "emails": [],
    "etag": "",
    "externalIds": [],
    "full_name": "Jane Smith",
    "gender": [],
    "guestAccountInfo": {
      "primaryGuestEmail": ""
    },
    "id": "108234567890123456789",
    "ims": [],
    "includeInGlobalAddressList": false,
    "ipWhitelisted": false,
    "isAdmin": false,
    "isDelegatedAdmin": false,
    "isEnforcedIn2Sv": false,
    "isEnrolledIn2Sv": false,
    "isGuestUser": false,
    "isMailboxSetup": false,
    "is_admin": false,
    "keywords": [],
    "kind": "admin#directory#user",
    "languages": [],
    "lastLoginTime": "2026-08-03T14:12:09.000Z",
    "last_sign_in": "2026-08-03",
    "last_sign_in_display": "Aug 3, 2026",
    "locations": [],
    "name": {
      "displayName": "Jane Smith",
      "familyName": "Smith",
      "fullName": "Jane Smith",
      "givenName": "Jane"
    },
    "never_signed_in": false,
    "nonEditableAliases": [],
    "notes": [],
    "orgUnitPath": "/Sales",
    "org_unit": "/Sales",
    "organizations": [],
    "phones": [],
    "posixAccounts": [],
    "primaryEmail": "jane@acme.com",
    "recoveryEmail": "",
    "recoveryPhone": "",
    "relations": [],
    "sshPublicKeys": [],
    "suspended": false,
    "suspensionReason": "",
    "suspensionTime": "",
    "thumbnailPhotoEtag": "",
    "thumbnailPhotoUrl": "",
    "websites": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List admin roles

List the administrator roles defined in your Google Workspace, one page at a time, each with its name and what it allows.

Inputs

Next page cursorpage_tokentext
To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
Page sizemax_resultsnumber
How many roles to return per page, from 1 to 100. Leave blank for Google's usual 100.From 1 to 100.
Customer IDcustomertext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.

Outputs

dataobject
What Google sent back.
has_moretrue/false
true when there is another page to read.
next_cursortext
Pass this to Next page cursor to read the next page. Empty on the last page.
Example output
{
  "data": {
    "etag": "example",
    "items": [],
    "kind": "example",
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List domains

List the domains your Google Workspace owns, such as acme.com, saying which is the primary one and which are verified.

Inputs

Customer IDcustomertext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "domains": [],
    "etag": "example",
    "kind": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List group aliases

List the extra email addresses (aliases) that deliver to a group.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "aliases": [],
    "etag": "example",
    "kind": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List group members

List the people and groups that belong to a Google Workspace group, one page at a time, each with their email address and role.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Page sizemax_resultsnumber
How many members to return per page, from 1 to 200. Leave blank for Google's usual 200.At least 1.
Rolesrolestext
Only list members with these roles: OWNER, MANAGER or MEMBER, separated by commas, for example OWNER,MANAGER. Leave blank for everyone.
Next page cursorpage_tokentext
To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
Include derived membershipinclude_derived_membershiptrue/false
Turn on to also list people who belong through a group nested inside this one.

Outputs

dataobject
What Google sent back.
has_moretrue/false
true when there is another page to read.
next_cursortext
Pass this to Next page cursor to read the next page. Empty on the last page.
Example output
{
  "data": {
    "etag": "example",
    "kind": "example",
    "members": [],
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List groups

List the groups in your Google Workspace, or only the groups one person belongs to, one page at a time, each with its name, email address and member count.

Inputs

Customer IDcustomertext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.
Page sizemax_resultsnumber
How many groups to return per page, from 1 to 200. Leave blank for Google's usual 200.At least 1.
Next page cursorpage_tokentext
To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
Queryquerytext
A search in Google's own format that narrows the list, for example email:sales* (addresses starting "sales"), name:'Sales Team' or memberKey=jane@acme.com (groups Jane belongs to).
Sort ordersort_ordertext
ASCENDING (A to Z) or DESCENDING (Z to A). Only used when Order by is set.One of: ASCENDING, DESCENDING.
Order byorder_bytext
Sort the list by the groups' email addresses. Email is the only choice.One of: email.
User keyuser_keytext
Only list the groups this person belongs to: their email address (jane@acme.com) or Google user ID. Leave blank for every group.
Domaindomaintext
Only list groups in this domain, for example acme.com. Leave blank for every domain in your organization.

Outputs

dataobject
What Google sent back.
has_moretrue/false
true when there is another page to read.
next_cursortext
Pass this to Next page cursor to read the next page. Empty on the last page.
Example output
{
  "data": {
    "etag": "example",
    "groups": [],
    "kind": "example",
    "nextPageToken": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List organizational units

List the organizational units (the folders people are sorted into, such as /Sales) in your Google Workspace, each with its name and full path.

Inputs

Customer IDcustomer_idtext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.
Org unit pathorg_unit_pathtext
The organizational unit to look inside, as its full path, for example /Sales. Leave blank to start from the top level.
Typetypetext
Which units to return: children (only the ones directly inside the starting unit, the default), all (every unit below it) or allIncludingParent (every unit below it and the starting unit itself).One of: all, children, allIncludingParent.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "etag": "example",
    "kind": "example",
    "organizationUnits": []
  },
  "has_more": false,
  "next_cursor": "example"
}

List user aliases

List the extra email addresses (aliases) that deliver to one person's mailbox.

Inputs

User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
Eventeventtext
Leave blank. Google uses this only for its change-notification requests; it does not filter the list.One of: add, delete.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "aliases": [],
    "etag": "example",
    "kind": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

List users

List the people in your Google Workspace, one page at a time (up to 500 a page), each with their name, email, last sign-in and whether they are suspended. Beta: turn on Read every page to get everyone in one step. To find people who haven't signed in for a while, use "List users who haven't signed in" instead.

Inputs

Page sizemax_resultsnumber
How many people to return per page, from 1 to 500. Leave blank for Google's usual 100.From 1 to 500.
Show deletedshow_deletedtext
Enter true to list the accounts deleted in the last 20 days instead of current ones. Leave blank for current accounts.
Custom field maskcustom_field_masktext
Which custom fields to include, as custom schema names separated by commas, for example Employment,Badges. Only used when Projection is "custom".
Next page cursorpage_tokentext
To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
Eventeventtext
Leave blank. Google uses this only for its change-notification requests; it does not filter the list.One of: add, delete, makeAdmin, undelete, update.
Order byorder_bytext
Sort the list by email, familyName (last name) or givenName (first name). Leave blank for Google's own order.One of: email, familyName, givenName.
Sort ordersort_ordertext
ASCENDING (A to Z) or DESCENDING (Z to A). Only used when Order by is set.One of: ASCENDING, DESCENDING.
Customer IDcustomertext
Leave blank for your own organization (the connected account, which Google calls "my_customer"). Enter a customer ID such as C03az79cb only for a different account you manage.
Projectionprojectiontext
How much of each person to return: basic (the standard fields, the default), custom (also the custom fields named in Custom field mask) or full (everything).One of: basic, custom, full.
Queryquerytext
A search in Google's own format that narrows the list, for example orgUnitPath='/Sales' (everyone in the Sales organizational unit), isSuspended=true (suspended accounts), isAdmin=true (super administrators), email:jo* (addresses starting "jo") or name:'Jane Smith'. Put a space between two conditions to require both. Google cannot search by last sign-in; use "List users who haven't signed in" for that.
Domaindomaintext
Only list people in this domain, for example acme.com. Leave blank for every domain in your organization.
View typeview_typetext
admin_view (the default) returns everything an administrator sees, including last sign-in. domain_public returns only what everyone in the organization can see.One of: admin_view, domain_public.
Read every pageall_pagestrue/false
Beta. Turn on to read every page and return everyone in one step, with no next page cursor to follow. Stops with an error past 10,000 people; narrow the list with Query or Domain.

Outputs

countnumber
Beta. How many people are in data.users.
dataobject
What Google sent back.
has_moretrue/false
true when there is another page to read.
next_cursortext
Pass this to Next page cursor to read the next page. Empty on the last page.
Example output
{
  "count": 1,
  "data": {
    "etag": "\"example\"",
    "kind": "admin#directory#users",
    "nextPageToken": "",
    "trigger_event": "",
    "users": [
      {
        "addresses": [],
        "agreedToTerms": false,
        "aliases": [],
        "archivalTime": "",
        "archived": false,
        "changePasswordAtNextLogin": false,
        "created": "2024-02-19",
        "created_display": "Feb 19, 2024",
        "creationTime": "2024-02-19T09:30:00.000Z",
        "customSchemas": {},
        "customerId": "C03az79cb",
        "days_since_sign_in": 100,
        "deletionTime": "",
        "email": "jane@acme.com",
        "emails": [],
        "etag": "",
        "externalIds": [],
        "full_name": "Jane Smith",
        "gender": [],
        "guestAccountInfo": {},
        "hashFunction": "",
        "id": "108234567890123456789",
        "ims": [],
        "includeInGlobalAddressList": false,
        "ipWhitelisted": false,
        "isAdmin": false,
        "isDelegatedAdmin": false,
        "isEnforcedIn2Sv": false,
        "isEnrolledIn2Sv": false,
        "isGuestUser": false,
        "isMailboxSetup": false,
        "is_admin": false,
        "keywords": [],
        "kind": "admin#directory#user",
        "languages": [],
        "lastLoginTime": "2026-08-03T14:12:09.000Z",
        "last_sign_in": "2026-08-03",
        "last_sign_in_display": "Aug 3, 2026",
        "locations": [],
        "name": {
          "displayName": "Jane Smith",
          "familyName": "Smith",
          "fullName": "Jane Smith",
          "givenName": "Jane"
        },
        "never_signed_in": false,
        "nonEditableAliases": [],
        "notes": [],
        "orgUnitPath": "/Sales",
        "org_unit": "/Sales",
        "organizations": [],
        "password": "",
        "phones": [],
        "posixAccounts": [],
        "primaryEmail": "jane@acme.com",
        "recoveryEmail": "",
        "recoveryPhone": "",
        "relations": [],
        "sshPublicKeys": [],
        "suspended": false,
        "suspensionReason": "",
        "suspensionTime": "",
        "thumbnailPhotoEtag": "",
        "thumbnailPhotoUrl": "",
        "websites": []
      }
    ]
  },
  "has_more": false,
  "next_cursor": null
}

List users who haven't signed in

Beta. List the Google Workspace users who haven't signed in for a number of days (inactive, dormant or unused accounts), ready for a report: each person's name, email, last sign-in date and days since, longest first, with a count. Google's directory cannot search by last sign-in, so this reads every page of users itself and keeps the ones that match: no loop, filter or paging steps needed. Suspended and archived accounts are left out unless you ask for them. People who have never signed in are included and marked.

Inputs

Days without signing ininactive_daysnumberRequired
Beta. Keep only people whose last sign-in was at least this many days ago, for example 90. A whole number from 1 to 3650.From 1 to 3650.
Include people who never signed ininclude_never_signed_intrue/false
Beta. People who have never signed in are included when their account is at least that many days old, marked never_signed_in with "Never" as the last sign-in. Turn off to leave them out. On unless you turn it off.
Include suspended accountsinclude_suspendedtrue/false
Beta. Suspended and archived accounts are left out, because nobody can sign in to them. Turn on to list them too. Off unless you turn it on.
Organizational unitorg_unit_pathtext
Beta. Only check people in this organizational unit and the units inside it, as its full path, for example /Sales. Leave blank to check everyone.
Domaindomaintext
Beta. Only check people in this domain, for example acme.com. Leave blank to check every domain in your organization.

Outputs

accounts_checkednumber
Beta. How many accounts were read to find them, across every page.
countnumber
Beta. How many people are in users. 0 when everyone has signed in recently.
cutoff_datetext
Beta. The day that many days ago, as a date in UTC (2026-08-13). Everyone listed last signed in on or before it.
cutoff_date_displaytext
Beta. The same day written out for a report ("Aug 13, 2026").
inactive_daysnumber
Beta. The number of days asked for.
never_signed_in_countnumber
Beta. How many of them have never signed in.
userslist
Beta. The people who haven't signed in, the longest-inactive first and those who never signed in last. Each has ready-to-read fields (full_name, email, last_sign_in_display) in front of Google's own; the rest of Google's fields for the person (phones, aliases and so on) are passed through as List users returns them.
Example output
{
  "accounts_checked": 48,
  "count": 2,
  "cutoff_date": "2026-08-13",
  "cutoff_date_display": "Aug 13, 2026",
  "inactive_days": 90,
  "never_signed_in_count": 1,
  "users": [
    {
      "archived": false,
      "created": "2024-02-19",
      "created_display": "Feb 19, 2024",
      "creationTime": "2024-02-19T09:30:00.000Z",
      "days_since_sign_in": 100,
      "email": "jane@acme.com",
      "full_name": "Jane Smith",
      "id": "108234567890123456789",
      "isAdmin": false,
      "isDelegatedAdmin": false,
      "is_admin": false,
      "lastLoginTime": "2026-08-03T14:12:09.000Z",
      "last_sign_in": "2026-08-03",
      "last_sign_in_display": "Aug 3, 2026",
      "name": {
        "displayName": "Jane Smith",
        "familyName": "Smith",
        "fullName": "Jane Smith",
        "givenName": "Jane"
      },
      "never_signed_in": false,
      "orgUnitPath": "/Sales",
      "org_unit": "/Sales",
      "primaryEmail": "jane@acme.com",
      "suspended": false
    },
    {
      "archived": false,
      "created": "2025-11-04",
      "created_display": "Nov 4, 2025",
      "creationTime": "2025-11-04T16:05:00.000Z",
      "days_since_sign_in": null,
      "email": "sam@acme.com",
      "full_name": "Sam Lee",
      "id": "104567890123456789012",
      "isAdmin": false,
      "isDelegatedAdmin": false,
      "is_admin": false,
      "lastLoginTime": "1970-01-01T00:00:00.000Z",
      "last_sign_in": "",
      "last_sign_in_display": "Never",
      "name": {
        "displayName": "Sam Lee",
        "familyName": "Lee",
        "fullName": "Sam Lee",
        "givenName": "Sam"
      },
      "never_signed_in": true,
      "orgUnitPath": "/Support",
      "org_unit": "/Support",
      "primaryEmail": "sam@acme.com",
      "suspended": false
    }
  ]
}

Remove group member

Remove a person or group from a Google Workspace group. Their account is not affected.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Member keymember_keytextRequired
The member: their email address (jane@acme.com) or Google ID.

Outputs

datanull
Empty: Google sends nothing back when this succeeds.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Restore user

Bring back a Google Workspace account deleted in the last 20 days, into the organizational unit you name.

Inputs

User keyuser_keytextRequired
The deleted person's Google user ID (List users with Show deleted set to true returns it). A deleted account can no longer be found by email address.
Org unit pathorg_unit_pathtext
The organizational unit to restore the person into, as its full path, for example /Sales. Use / for the top level.

Outputs

datanull
Empty: Google sends nothing back when this succeeds.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Sign out user

Sign a person out of every device and browser where they are signed in to their Google Workspace account.

Inputs

User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

Outputs

datanull
Empty: Google sends nothing back when this succeeds.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": null,
  "has_more": false,
  "next_cursor": "example"
}

Update group

Change a Google Workspace group's name, description or email address. Only the fields you fill in change.

Inputs

Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Admin createdadmin_createdtrue/false
Leave blank. Google records for itself whether an administrator created the group.
Emailemailtext
A new email address for the group, for example sales-team@acme.com. Leave blank to keep the current one.
Descriptiondescriptiontext
A new description of what the group is for. Leave blank to keep the current one.
Namenametext
A new name for the group, for example Sales Team. Leave blank to keep the current one.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "adminCreated": false,
    "aliases": [],
    "description": "example",
    "directMembersCount": "example",
    "email": "example",
    "etag": "example",
    "externalIds": [],
    "id": "example",
    "kind": "example",
    "name": "example",
    "nonEditableAliases": []
  },
  "has_more": false,
  "next_cursor": "example"
}

Update group member

Change a group member's role or how they receive the group's email.

Inputs

Member keymember_keytextRequired
The member: their email address (jane@acme.com) or Google ID.
Group keygroup_keytextRequired
The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
Delivery settingsdelivery_settingstext
How the member receives the group's email: ALL_MAIL (every message as it arrives), DAILY (at most one message a day), DIGEST (up to 25 messages bundled into one), DISABLED (unsubscribed) or NONE (no email). Leave blank to keep the current setting.One of: ALL_MAIL, DAILY, DIGEST, DISABLED, NONE.
Roleroletext
A new role in the group: MEMBER, MANAGER or OWNER. Leave blank to keep the current one.One of: MEMBER, MANAGER, OWNER.
Emailemailtext
Leave blank. The member is chosen with Member key and their address is kept.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "delivery_settings": "example",
    "email": "example",
    "etag": "example",
    "id": "example",
    "kind": "example",
    "role": "example",
    "status": "example",
    "type": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

Update user

Change a person's Google Workspace account: their name, email address, password, organizational unit, or suspend or restore them. Only the fields you fill in change.

Inputs

User keyuser_keytextRequired
The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
Recovery emailrecovery_emailtext
A personal email address the person can use to get back into their account, for example jane@gmail.com. Leave blank to keep the current one.
Passwordpasswordtext
A new password, 8 to 100 characters. Leave blank to keep the current one.
Primary emailprimary_emailtext
A new sign-in email address, for example jane.smith@acme.com. Leave blank to keep the current one.
Suspendedsuspendedtrue/false
Turn on to suspend the account so the person cannot sign in; turn off to give access back. Leave blank to change nothing.
Change password at next loginchange_password_at_next_logintrue/false
Turn on to make the person choose a new password the next time they sign in.
Org unit pathorg_unit_pathtext
The organizational unit to move the person to, as its full path, for example /Sales/West. Leave blank to leave them where they are.
Given namegiven_nametext
A new first name. Leave blank to keep the current one.
Family namefamily_nametext
A new last name. Leave blank to keep the current one.

Outputs

dataobject
What Google sent back.
has_moretrue/false
Always false: this action has no further pages.
next_cursortext
Always empty: this action has no further pages.
Example output
{
  "data": {
    "addresses": "example",
    "agreedToTerms": false,
    "aliases": [],
    "archivalTime": "example",
    "archived": false,
    "changePasswordAtNextLogin": false,
    "creationTime": "2026-01-01T00:00:00Z",
    "customSchemas": {},
    "customerId": "example",
    "deletionTime": "2026-01-01T00:00:00Z",
    "emails": "example",
    "etag": "example",
    "externalIds": "example",
    "gender": "example",
    "guestAccountInfo": {
      "primaryGuestEmail": "example"
    },
    "id": "example",
    "ims": "example",
    "includeInGlobalAddressList": false,
    "ipWhitelisted": false,
    "isAdmin": false,
    "isDelegatedAdmin": false,
    "isEnforcedIn2Sv": false,
    "isEnrolledIn2Sv": false,
    "isGuestUser": false,
    "isMailboxSetup": false,
    "keywords": "example",
    "kind": "example",
    "languages": "example",
    "lastLoginTime": "2026-01-01T00:00:00Z",
    "locations": "example",
    "name": {
      "displayName": "example",
      "familyName": "example",
      "fullName": "example",
      "givenName": "example"
    },
    "nonEditableAliases": [],
    "notes": "example",
    "orgUnitPath": "example",
    "organizations": "example",
    "phones": "example",
    "posixAccounts": "example",
    "primaryEmail": "example",
    "recoveryEmail": "example",
    "recoveryPhone": "example",
    "relations": "example",
    "sshPublicKeys": "example",
    "suspended": false,
    "suspensionReason": "example",
    "suspensionTime": "example",
    "thumbnailPhotoEtag": "example",
    "thumbnailPhotoUrl": "example",
    "websites": "example"
  },
  "has_more": false,
  "next_cursor": "example"
}

On this page