# Google Workspace Admin

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

App · 26 actions. Web page: https://docs.lodol.com/docs/integrations/google-workspace-admin

## Actions

### Add group member

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

**Inputs**

- Group key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Delivery settings (`delivery_settings`, text): 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`.
- Role (`role`, text, required): The role to give them in the group: MEMBER, MANAGER or OWNER. One of: `MEMBER`, `MANAGER`, `OWNER`.
- Email (`email`, text, required): The email address of the person or group to add, for example jane@acme.com.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 created (`admin_created`, true/false): Leave blank. Google records for itself whether an administrator created the group.
- Email (`email`, text, required): The group's email address, on one of your domains, for example sales@acme.com.
- Description (`description`, text): A sentence or two saying what the group is for.
- Name (`name`, text): The group's name as people see it, for example Sales Team.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 ID (`customer_id`, text): 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.
- Description (`description`, text): A sentence saying what the organizational unit is for.
- Name (`name`, text, required): The new unit's name, for example West. It becomes the last part of its path (/Sales/West).
- Block inheritance (`block_inheritance`, true/false): Leave blank. Google no longer lets a unit block the settings it inherits.
- Parent org unit path (`parent_org_unit_path`, text): The full path of the unit to create this one inside, for example /Sales. Use / for the top level.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 account (`resolve_conflict_account`, true/false): Turn on to apply your organization's setting for conflicting accounts when a personal Google account already uses this email address.
- Recovery email (`recovery_email`, text): A personal email address the person can use to get back into their account, for example jane@gmail.com.
- Password (`password`, text, required): The account's password, 8 to 100 characters.
- Primary email (`primary_email`, text, required): The person's sign-in email address, on one of your domains, for example jane@acme.com.
- Suspended (`suspended`, true/false): Turn on to create the account suspended, so the person cannot sign in yet.
- Change password at next login (`change_password_at_next_login`, true/false): Turn on to make the person choose a new password the first time they sign in.
- Org unit path (`org_unit_path`, text): The organizational unit to put the person in, as its full path, for example /Sales/West. Leave blank for the top level (/).
- Given name (`given_name`, text, required): The person's first name.
- Family name (`family_name`, text, required): The person's last name.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
- Primary email (`primary_email`, text): Leave blank. Google fills in the person's primary email address.
- Etag (`etag`, text): Leave blank. Google's own version marker for the record.
- Alias (`alias`, text, required): The extra email address to give the person, on one of your domains, for example j.smith@acme.com.
- Id (`id`, text): Leave blank. Google fills in the person's ID.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

**Outputs**

- `data` (null): Empty: Google sends nothing back when this succeeds.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

**Outputs**

- `data` (null): Empty: Google sends nothing back when this succeeds.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Member key (`member_key`, text, required): The member: their email address (jane@acme.com) or Google ID.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 ID (`customer_id`, text): 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 path (`org_unit_path`, text, required): The organizational unit's full path, for example /Sales/West.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 mask (`custom_field_mask`, text): Which custom fields to include, as custom schema names separated by commas, for example Employment,Badges. Leave blank for the standard fields.
- User key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 cursor (`page_token`, text): To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
- Page size (`max_results`, number): How many roles to return per page, from 1 to 100. Leave blank for Google's usual 100. From 1 to 100.
- Customer ID (`customer`, text): 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**

- `data` (object): What Google sent back.
- `has_more` (true/false): true when there is another page to read.
- `next_cursor` (text): Pass this to Next page cursor to read the next page. Empty on the last page.

**Example output**

```json
{
  "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 ID (`customer`, text): 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**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Page size (`max_results`, number): How many members to return per page, from 1 to 200. Leave blank for Google's usual 200. At least 1.
- Roles (`roles`, text): Only list members with these roles: OWNER, MANAGER or MEMBER, separated by commas, for example OWNER,MANAGER. Leave blank for everyone.
- Next page cursor (`page_token`, text): To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
- Include derived membership (`include_derived_membership`, true/false): Turn on to also list people who belong through a group nested inside this one.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): true when there is another page to read.
- `next_cursor` (text): Pass this to Next page cursor to read the next page. Empty on the last page.

**Example output**

```json
{
  "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 ID (`customer`, text): 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 size (`max_results`, number): How many groups to return per page, from 1 to 200. Leave blank for Google's usual 200. At least 1.
- Next page cursor (`page_token`, text): To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
- Query (`query`, text): 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 order (`sort_order`, text): ASCENDING (A to Z) or DESCENDING (Z to A). Only used when Order by is set. One of: `ASCENDING`, `DESCENDING`.
- Order by (`order_by`, text): Sort the list by the groups' email addresses. Email is the only choice. One of: `email`.
- User key (`user_key`, text): Only list the groups this person belongs to: their email address (jane@acme.com) or Google user ID. Leave blank for every group.
- Domain (`domain`, text): Only list groups in this domain, for example acme.com. Leave blank for every domain in your organization.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): true when there is another page to read.
- `next_cursor` (text): Pass this to Next page cursor to read the next page. Empty on the last page.

**Example output**

```json
{
  "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 ID (`customer_id`, text): 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 path (`org_unit_path`, text): The organizational unit to look inside, as its full path, for example /Sales. Leave blank to start from the top level.
- Type (`type`, text): 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**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
- Event (`event`, text): Leave blank. Google uses this only for its change-notification requests; it does not filter the list. One of: `add`, `delete`.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 size (`max_results`, number): How many people to return per page, from 1 to 500. Leave blank for Google's usual 100. From 1 to 500.
- Show deleted (`show_deleted`, text): Enter true to list the accounts deleted in the last 20 days instead of current ones. Leave blank for current accounts.
- Custom field mask (`custom_field_mask`, text): Which custom fields to include, as custom schema names separated by commas, for example Employment,Badges. Only used when Projection is "custom".
- Next page cursor (`page_token`, text): To get the next page, pass the next_cursor value from the previous step. Leave blank for the first page.
- Event (`event`, text): 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 by (`order_by`, text): 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 order (`sort_order`, text): ASCENDING (A to Z) or DESCENDING (Z to A). Only used when Order by is set. One of: `ASCENDING`, `DESCENDING`.
- Customer ID (`customer`, text): 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.
- Projection (`projection`, text): 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`.
- Query (`query`, text): 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.
- Domain (`domain`, text): Only list people in this domain, for example acme.com. Leave blank for every domain in your organization.
- View type (`view_type`, text): 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 page (`all_pages`, true/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**

- `count` (number): Beta. How many people are in data.users.
- `data` (object): What Google sent back.
- `has_more` (true/false): true when there is another page to read.
- `next_cursor` (text): Pass this to Next page cursor to read the next page. Empty on the last page.

**Example output**

```json
{
  "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 in (`inactive_days`, number, required): 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 in (`include_never_signed_in`, true/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 accounts (`include_suspended`, true/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 unit (`org_unit_path`, text): 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.
- Domain (`domain`, text): Beta. Only check people in this domain, for example acme.com. Leave blank to check every domain in your organization.

**Outputs**

- `accounts_checked` (number): Beta. How many accounts were read to find them, across every page.
- `count` (number): Beta. How many people are in users. 0 when everyone has signed in recently.
- `cutoff_date` (text): 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_display` (text): Beta. The same day written out for a report ("Aug 13, 2026").
- `inactive_days` (number): Beta. The number of days asked for.
- `never_signed_in_count` (number): Beta. How many of them have never signed in.
- `users` (list): 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**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Member key (`member_key`, text, required): The member: their email address (jane@acme.com) or Google ID.

**Outputs**

- `data` (null): Empty: Google sends nothing back when this succeeds.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): 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 path (`org_unit_path`, text): The organizational unit to restore the person into, as its full path, for example /Sales. Use / for the top level.

**Outputs**

- `data` (null): Empty: Google sends nothing back when this succeeds.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.

**Outputs**

- `data` (null): Empty: Google sends nothing back when this succeeds.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Admin created (`admin_created`, true/false): Leave blank. Google records for itself whether an administrator created the group.
- Email (`email`, text): A new email address for the group, for example sales-team@acme.com. Leave blank to keep the current one.
- Description (`description`, text): A new description of what the group is for. Leave blank to keep the current one.
- Name (`name`, text): A new name for the group, for example Sales Team. Leave blank to keep the current one.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`member_key`, text, required): The member: their email address (jane@acme.com) or Google ID.
- Group key (`group_key`, text, required): The group: its email address (sales@acme.com), one of its alias addresses, or its Google group ID.
- Delivery settings (`delivery_settings`, text): 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`.
- Role (`role`, text): A new role in the group: MEMBER, MANAGER or OWNER. Leave blank to keep the current one. One of: `MEMBER`, `MANAGER`, `OWNER`.
- Email (`email`, text): Leave blank. The member is chosen with Member key and their address is kept.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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 key (`user_key`, text, required): The person: their primary email address (jane@acme.com), one of their alias addresses, or their Google user ID.
- Recovery email (`recovery_email`, text): 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.
- Password (`password`, text): A new password, 8 to 100 characters. Leave blank to keep the current one.
- Primary email (`primary_email`, text): A new sign-in email address, for example jane.smith@acme.com. Leave blank to keep the current one.
- Suspended (`suspended`, true/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 login (`change_password_at_next_login`, true/false): Turn on to make the person choose a new password the next time they sign in.
- Org unit path (`org_unit_path`, text): 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 name (`given_name`, text): A new first name. Leave blank to keep the current one.
- Family name (`family_name`, text): A new last name. Leave blank to keep the current one.

**Outputs**

- `data` (object): What Google sent back.
- `has_more` (true/false): Always false: this action has no further pages.
- `next_cursor` (text): Always empty: this action has no further pages.

**Example output**

```json
{
  "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"
}
```
