Productivity

Google admin

Learn how to use Google admin with Composio

Overview

SLUG: 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
stringDefaults to https://backend.composio.dev/api/v1/auth-apps/add
scopes
stringDefaults to https://www.googleapis.com/auth/admin.directory.user,https://www.googleapis.com/auth/admin.directory.user.readonly,https://www.googleapis.com/auth/admin.directory.user.alias,https://www.googleapis.com/auth/admin.directory.user.alias.readonly,https://www.googleapis.com/auth/admin.directory.group,https://www.googleapis.com/auth/admin.directory.group.readonly,https://www.googleapis.com/auth/admin.directory.group.member,https://www.googleapis.com/auth/admin.directory.group.member.readonly,https://www.googleapis.com/auth/admin.directory.orgunit,https://www.googleapis.com/auth/admin.directory.orgunit.readonly,https://www.googleapis.com/auth/admin.directory.domain,https://www.googleapis.com/auth/admin.directory.domain.readonly
bearer_token
string

Connecting to Google admin

Create an auth config

Use the dashboard to create an auth config for the Google admin toolkit. This allows you to connect multiple Google admin accounts to Composio for agents to use.

1

Select App

Navigate to [Google admin](https://platform.composio.dev/marketplace/Google admin).

2

Configure Auth Config Settings

Select among the supported auth schemes of and configure them here.

3

Create and Get auth config ID

Click “Create Google admin Auth Config”. After creation, copy the displayed ID starting with ac_. This is your auth config ID. This is not a sensitive ID — you can save it in environment variables or a database. This ID will be used to create connections to the toolkit for a given user.

Connect Your Account

Using OAuth2

1from composio import Composio
2
3# Replace these with your actual values
4google_admin_auth_config_id = "ac_YOUR_GOOGLE_ADMIN_CONFIG_ID" # Auth config ID created above
5user_id = "0000-0000-0000"  # UUID from database/application
6
7composio = Composio()
8
9
10def authenticate_toolkit(user_id: str, auth_config_id: str):
11    connection_request = composio.connected_accounts.initiate(
12        user_id=user_id,
13        auth_config_id=auth_config_id,
14    )
15
16    print(
17        f"Visit this URL to authenticate Google admin: {connection_request.redirect_url}"
18    )
19
20    # This will wait for the auth flow to be completed
21    connection_request.wait_for_connection(timeout=15)
22    return connection_request.id
23
24
25connection_id = authenticate_toolkit(user_id, google_admin_auth_config_id)
26
27# You can also verify the connection status using:
28connected_account = composio.connected_accounts.get(connection_id)
29print(f"Connected account: {connected_account}")

Tools

Executing tools

To prototype you can execute some tools to see the responses and working on the [Google admin toolkit’s playground](https://app.composio.dev/app/Google admin)

Python
1from composio import Composio
2from openai import OpenAI
3import json
4
5openai = OpenAI()
6composio = Composio()
7
8# User ID must be a valid UUID format
9user_id = "0000-0000-0000"  # Replace with actual user UUID from your database
10
11tools = composio.tools.get(user_id=user_id, toolkits=["GOOGLE_ADMIN"])
12
13print("[!] Tools:")
14print(json.dumps(tools))
15
16def invoke_llm(task = "What can you do?"):
17    completion = openai.chat.completions.create(
18        model="gpt-4o",
19        messages=[
20            {
21                "role": "user",
22                "content": task,  # Your task here!
23            },
24        ],
25        tools=tools,
26    )
27
28    # Handle Result from tool call
29    result = composio.provider.handle_tool_calls(user_id=user_id, response=completion)
30    print(f"[!] Completion: {completion}")
31    print(f"[!] Tool call result: {result}")
32
33invoke_llm()

Tool List

Tool Name: Add Alias to Google Workspace User

Description

Adds an email alias to a google workspace user.

Action Parameters

alias
stringRequired
user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Add User to Google Workspace Group

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Google Workspace Group

Description

Creates a new google workspace group with the specified details.

Action Parameters

description
string
email
stringRequired
name
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Create Google Workspace User

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Delete Google Workspace User

Description

Deletes a google workspace user permanently. this action cannot be undone.

Action Parameters

user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Google Workspace Group Details

Description

Retrieves detailed information about a google workspace group.

Action Parameters

group_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Get Google Workspace User Details

Description

Retrieves detailed information about a google workspace user.

Action Parameters

user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: List Google Workspace Groups

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: List Google Workspace Group Members

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: List Google Workspace Users

Description

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
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove Alias from Google Workspace User

Description

Removes an email alias from a google workspace user.

Action Parameters

alias
stringRequired
user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Remove User from Google Workspace Group

Description

Removes a user from a google workspace group, revoking their group access.

Action Parameters

group_key
stringRequired
user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Suspend/Unsuspend Google Workspace User

Description

Suspends or unsuspends a google workspace user account.

Action Parameters

suspended
booleanDefaults to True
suspension_reason
string
user_key
stringRequired

Action Response

data
objectRequired
error
string
successful
booleanRequired

Tool Name: Update Google Workspace Group Settings

Description

Updates settings for a google workspace group.

Action Parameters

description
string
group_key
stringRequired
name
string

Action Response

data
objectRequired
error
string
successful
booleanRequired