Tools

Google Admin

Learn how to use Google Admin with Composio

Overview

Enum

GOOGLE_ADMIN

Description

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

Authentication Details

client_id
stringRequired
client_secret
stringRequired
oauth_redirect_uri
string
scopes
string
access_token
string

Actions

Adds an email alias to a google workspace user.

Action Parameters

alias
stringRequired
user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Adds a user to a google workspace group with the specified role.

Action Parameters

group_key
stringRequired
role
stringDefaults to MEMBER
user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates a new google workspace group with the specified details.

Action Parameters

description
string
email
stringRequired
name
stringRequired

Action Response

data
object
error
string
successful
boolean
Creates a new google workspace user with the specified details.

Action Parameters

change_password_at_next_login
booleanDefaults to True
family_name
stringRequired
given_name
stringRequired
org_unit_path
stringDefaults to /
password
stringRequired
primary_email
stringRequired
recovery_email
string
recovery_phone
string
suspended
boolean

Action Response

data
object
error
string
successful
boolean
Deletes a google workspace user permanently. this action cannot be undone.

Action Parameters

user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves detailed information about a google workspace group.

Action Parameters

group_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Retrieves detailed information about a google workspace user.

Action Parameters

user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Lists all members of a google workspace group with optional filtering and pagination.

Action Parameters

group_key
stringRequired
include_derived_membership
boolean
max_results
integerDefaults to 200
page_token
string
roles
string

Action Response

data
object
error
string
successful
boolean
Lists google workspace groups with optional filtering and pagination.

Action Parameters

customer
stringDefaults to my_customer
domain
string
max_results
integerDefaults to 200
order_by
stringDefaults to email
page_token
string
query
string
sort_order
stringDefaults to ASCENDING

Action Response

data
object
error
string
successful
boolean
Lists google workspace users with optional filtering and pagination.

Action Parameters

customer
stringDefaults to my_customer
domain
string
max_results
integerDefaults to 100
order_by
stringDefaults to email
page_token
string
query
string
sort_order
stringDefaults to ASCENDING

Action Response

data
object
error
string
successful
boolean
Removes an email alias from a google workspace user.

Action Parameters

alias
stringRequired
user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Removes a user from a google workspace group, revoking their group access.

Action Parameters

group_key
stringRequired
user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Suspends or unsuspends a google workspace user account.

Action Parameters

suspended
booleanDefaults to True
suspension_reason
string
user_key
stringRequired

Action Response

data
object
error
string
successful
boolean
Updates settings for a google workspace group.

Action Parameters

description
string
group_key
stringRequired
name
string

Action Response

data
object
error
string
successful
boolean