Skip to main content
Google Admin logo
  • Category: security & identity tools
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 14
  • Triggers: 0
  • Slug: GOOGLE_ADMIN
  • Version: 20261101_00

Frequently Asked Questions

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.

Tools

Slug: GOOGLE_ADMIN_ADD_USER_ALIASAdds an email alias to a Google Workspace user.

Input Parameters

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.
string
required
User’s primary email address or unique user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_ADD_USER_TO_GROUPAdds a user to a Google Workspace group with the specified role.

Input Parameters

string
Role of the user in the group (MEMBER, MANAGER, OWNER)
string
required
User’s primary email address or unique user ID to add to the group
string
required
Group’s email address or unique group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_CREATE_GROUPCreates a new Google Workspace group with the specified details.

Input Parameters

string
required
Display name for the group
string
required
Group’s email address (will be the group ID)
string
Description of the group’s purpose

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_CREATE_USERCreates a new Google Workspace user with the specified details. Fails if primary_email already exists; cannot update existing accounts.

Input Parameters

string
required
User’s password (must meet domain password requirements)
boolean
Whether the user account is suspended
string
required
User’s first name
string
required
User’s last name
string
Organizational unit path for the user Defaults to root OU (’/’), which applies domain-wide policies; set explicitly if per-OU policies differ.
string
required
User’s primary email address
string
Recovery email address
string
Recovery phone number
boolean
Whether user must change password at next login

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_DELETE_USERDeletes a Google Workspace user. A deleted user may be recoverable, subject to Google’s restoration conditions.

Input Parameters

string
required
User’s primary email address or unique user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_GET_GROUPRetrieves detailed information about a Google Workspace group.

Input Parameters

string
required
Group’s email address or unique group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_GET_USERRetrieves detailed information about a Google Workspace user.

Input Parameters

string
required
User’s primary email address or unique user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_LIST_GROUP_MEMBERSLists all members of a Google Workspace group with optional filtering and pagination.

Input Parameters

string
Comma-separated list of roles to filter by (OWNER, MANAGER, MEMBER)
string
required
Group’s email address or unique group ID
string
Token for retrieving next page of results
integer
Maximum number of results to return (1-200)
boolean
Whether to include indirect memberships from nested groups

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_LIST_GROUPSLists Google Workspace groups with optional filtering and pagination.

Input Parameters

string
Query string for filtering groups (e.g., ‘name=Engineering*’)
string
Domain name to list groups from
string
Customer ID or ‘my_customer’ for the authenticated user’s customer
string
Property to order results by (email)
string
Token for retrieving next page of results
string
Sort order (ASCENDING or DESCENDING)
integer
Maximum number of results to return (1-200)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_LIST_USERSLists Google Workspace users with optional filtering and pagination.

Input Parameters

string
Query string for filtering users (e.g., ‘orgName=Engineering’)
string
Domain name to list users from (if not specified, uses the authenticated user’s domain)
string
Customer ID or ‘my_customer’ for the authenticated user’s customer
string
Property to order results by (email, givenName, familyName)
string
Token for retrieving next page of results
string
Sort order (ASCENDING or DESCENDING)
integer
Maximum number of results to return (1-500)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_REMOVE_USER_ALIASRemoves an email alias from a Google Workspace user.

Input Parameters

string
required
Alias email address to remove from the user
string
required
User’s primary email address or unique user ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_REMOVE_USER_FROM_GROUPRemoves a user from a Google Workspace group, revoking their group access.

Input Parameters

string
required
User’s primary email address or unique user ID to remove from the group
string
required
Group’s email address or unique group ID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_SUSPEND_USERSuspends or unsuspends a Google Workspace user account.

Input Parameters

string
required
User’s primary email address or unique user ID
boolean
Whether to suspend (True) or unsuspend (False) the user
string
Reason for suspension (optional)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: GOOGLE_ADMIN_UPDATE_GROUP_SETTINGSUpdates a Google Workspace group’s display name and/or description.

Input Parameters

string
Updated display name for the group
string
required
Group’s email address or unique group ID
string
Updated group description

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not