> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Google Admin

> Google Admin Console for managing Google Workspace users, groups, and organizational units.

![Google Admin logo](https://mintcdn.com/composio-preview/GL28i3tBlbEbBd-f/images/toolkits/google_admin.svg?fit=max\&auto=format\&n=GL28i3tBlbEbBd-f\&q=85\&s=1303547a320a57d356c93ad51f440fee)

* **Category:** security & identity tools
* **Auth:** OAUTH2
* **Composio-managed OAuth available?** No
* **Tools:** 14
* **Triggers:** 0
* **Slug:** `GOOGLE_ADMIN`
* **Version:** 20261101\_00

## Frequently Asked Questions

> [accordion] How do I set up custom Google OAuth credentials for Google Admin?
>
> For a step-by-step guide on creating and configuring your own Google OAuth credentials with Composio, see [How to create OAuth2 credentials for Google Apps](https://composio.dev/auth/googleapps).

## Tools

> [accordion] Add Alias to Google Workspace User
>
> **Slug:** `GOOGLE_ADMIN_ADD_USER_ALIAS`
>
> Adds an email alias to a Google Workspace user.
>
> #### Input Parameters
>
> **alias** `string` *required*
>
> Alias email address to add to the user Must be unique across the entire domain; adding a duplicate alias already assigned to any user will fail.
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add User to Google Workspace Group
>
> **Slug:** `GOOGLE_ADMIN_ADD_USER_TO_GROUP`
>
> Adds a user to a Google Workspace group with the specified role.
>
> #### Input Parameters
>
> **role** `string`
>
> Role of the user in the group (MEMBER, MANAGER, OWNER)
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID to add to the group
>
> **group\_key** `string` *required*
>
> Group's email address or unique group ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Google Workspace Group
>
> **Slug:** `GOOGLE_ADMIN_CREATE_GROUP`
>
> Creates a new Google Workspace group with the specified details.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Display name for the group
>
> **email** `string` *required*
>
> Group's email address (will be the group ID)
>
> **description** `string`
>
> Description of the group's purpose
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Google Workspace User
>
> **Slug:** `GOOGLE_ADMIN_CREATE_USER`
>
> Creates a new Google Workspace user with the specified details. Fails if `primary_email` already exists; cannot update existing accounts.
>
> #### Input Parameters
>
> **password** `string` *required*
>
> User's password (must meet domain password requirements)
>
> **suspended** `boolean`
>
> Whether the user account is suspended
>
> **given\_name** `string` *required*
>
> User's first name
>
> **family\_name** `string` *required*
>
> User's last name
>
> **org\_unit\_path** `string`
>
> Organizational unit path for the user Defaults to root OU ('/'), which applies domain-wide policies; set explicitly if per-OU policies differ.
>
> **primary\_email** `string` *required*
>
> User's primary email address
>
> **recovery\_email** `string`
>
> Recovery email address
>
> **recovery\_phone** `string`
>
> Recovery phone number
>
> **change\_password\_at\_next\_login** `boolean`
>
> Whether user must change password at next login
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Google Workspace User
>
> **Slug:** `GOOGLE_ADMIN_DELETE_USER`
>
> Deletes a Google Workspace user. A deleted user may be recoverable, subject to Google's restoration conditions.
>
> #### Input Parameters
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Google Workspace Group Details
>
> **Slug:** `GOOGLE_ADMIN_GET_GROUP`
>
> Retrieves detailed information about a Google Workspace group.
>
> #### Input Parameters
>
> **group\_key** `string` *required*
>
> Group's email address or unique group ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Google Workspace User Details
>
> **Slug:** `GOOGLE_ADMIN_GET_USER`
>
> Retrieves detailed information about a Google Workspace user.
>
> #### Input Parameters
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Google Workspace Group Members
>
> **Slug:** `GOOGLE_ADMIN_LIST_GROUP_MEMBERS`
>
> Lists all members of a Google Workspace group with optional filtering and pagination.
>
> #### Input Parameters
>
> **roles** `string`
>
> Comma-separated list of roles to filter by (OWNER, MANAGER, MEMBER)
>
> **group\_key** `string` *required*
>
> Group's email address or unique group ID
>
> **page\_token** `string`
>
> Token for retrieving next page of results
>
> **max\_results** `integer`
>
> Maximum number of results to return (1-200)
>
> **include\_derived\_membership** `boolean`
>
> Whether to include indirect memberships from nested groups
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Google Workspace Groups
>
> **Slug:** `GOOGLE_ADMIN_LIST_GROUPS`
>
> Lists Google Workspace groups with optional filtering and pagination.
>
> #### Input Parameters
>
> **query** `string`
>
> Query string for filtering groups (e.g., 'name=Engineering\*')
>
> **domain** `string`
>
> Domain name to list groups from
>
> **customer** `string`
>
> Customer ID or 'my\_customer' for the authenticated user's customer
>
> **order\_by** `string`
>
> Property to order results by (email)
>
> **page\_token** `string`
>
> Token for retrieving next page of results
>
> **sort\_order** `string`
>
> Sort order (ASCENDING or DESCENDING)
>
> **max\_results** `integer`
>
> Maximum number of results to return (1-200)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Google Workspace Users
>
> **Slug:** `GOOGLE_ADMIN_LIST_USERS`
>
> Lists Google Workspace users with optional filtering and pagination.
>
> #### Input Parameters
>
> **query** `string`
>
> Query string for filtering users (e.g., 'orgName=Engineering')
>
> **domain** `string`
>
> Domain name to list users from (if not specified, uses the authenticated user's domain)
>
> **customer** `string`
>
> Customer ID or 'my\_customer' for the authenticated user's customer
>
> **order\_by** `string`
>
> Property to order results by (email, givenName, familyName)
>
> **page\_token** `string`
>
> Token for retrieving next page of results
>
> **sort\_order** `string`
>
> Sort order (ASCENDING or DESCENDING)
>
> **max\_results** `integer`
>
> Maximum number of results to return (1-500)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Alias from Google Workspace User
>
> **Slug:** `GOOGLE_ADMIN_REMOVE_USER_ALIAS`
>
> Removes an email alias from a Google Workspace user.
>
> #### Input Parameters
>
> **alias** `string` *required*
>
> Alias email address to remove from the user
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove User from Google Workspace Group
>
> **Slug:** `GOOGLE_ADMIN_REMOVE_USER_FROM_GROUP`
>
> Removes a user from a Google Workspace group, revoking their group access.
>
> #### Input Parameters
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID to remove from the group
>
> **group\_key** `string` *required*
>
> Group's email address or unique group ID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suspend/Unsuspend Google Workspace User
>
> **Slug:** `GOOGLE_ADMIN_SUSPEND_USER`
>
> Suspends or unsuspends a Google Workspace user account.
>
> #### Input Parameters
>
> **user\_key** `string` *required*
>
> User's primary email address or unique user ID
>
> **suspended** `boolean`
>
> Whether to suspend (True) or unsuspend (False) the user
>
> **suspension\_reason** `string`
>
> Reason for suspension (optional)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Google Workspace Group Settings
>
> **Slug:** `GOOGLE_ADMIN_UPDATE_GROUP_SETTINGS`
>
> Updates a Google Workspace group's display name and/or description.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated display name for the group
>
> **group\_key** `string` *required*
>
> Group's email address or unique group ID
>
> **description** `string`
>
> Updated group description
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
