Documentation Index
Fetch the complete documentation index at: https://docs.pinkfish.ai/llms.txt
Use this file to discover all available pages before exploring further.
Server path: /google-workspace-admin | Type: Application | PCID required: Yes
| Tool | Description |
|---|
google-workspace-admin_create_user | Create a new user in Google Workspace with email, name, and password |
google-workspace-admin_get_user | Get detailed information about a specific user |
google-workspace-admin_list_users | List all users in the Google Workspace organization with optional filtering |
google-workspace-admin_update_user | Update an existing user in Google Workspace |
google-workspace-admin_delete_user | Delete a user from Google Workspace |
google-workspace-admin_create_group | Create a new group in Google Workspace |
google-workspace-admin_get_group | Get detailed information about a specific group |
google-workspace-admin_list_groups | List all groups in the Google Workspace organization with optional filtering |
google-workspace-admin_update_group | Update an existing group in Google Workspace |
google-workspace-admin_delete_group | Delete a group from Google Workspace |
google-workspace-admin_add_user_to_group | Add a user to a group in Google Workspace |
google-workspace-admin_remove_user_from_group | Remove a user from a group in Google Workspace |
google-workspace-admin_list_group_members | List all members of a specific group |
google-workspace-admin_create_user
Create a new user in Google Workspace with email, name, and password
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
primaryEmail | string | Yes | — | Primary email address for the user |
givenName | string | Yes | — | User’s first name |
familyName | string | Yes | — | User’s last name |
password | string | Yes | — | Password for the user (minimum 8 characters) |
orgUnitPath | string | No | — | Organizational unit path (e.g., /Engineering, /Sales) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"primaryEmail": {
"type": "string",
"description": "Primary email address for the user"
},
"givenName": {
"type": "string",
"description": "User's first name"
},
"familyName": {
"type": "string",
"description": "User's last name"
},
"password": {
"type": "string",
"description": "Password for the user (minimum 8 characters)"
},
"orgUnitPath": {
"type": "string",
"description": "Organizational unit path (e.g., /Engineering, /Sales)"
}
},
"required": [
"PCID",
"primaryEmail",
"givenName",
"familyName",
"password"
]
}
google-workspace-admin_get_user
Get detailed information about a specific user
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userKey | string | Yes | — | User’s primary email address or unique ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"userKey": {
"type": "string",
"description": "User's primary email address or unique ID"
}
},
"required": [
"PCID",
"userKey"
]
}
google-workspace-admin_list_users
List all users in the Google Workspace organization with optional filtering
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
domain | string | No | — | Domain to list users from (defaults to primary domain) |
maxResults | number | No | 100 | Maximum number of results to return (1-500) |
orderBy | string | No | — | Sort order for results |
query | string | No | — | Search query (e.g., “name:John*” or “orgUnitPath=/Engineering”) |
pageToken | string | No | — | Token for paginating through results |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"domain": {
"type": "string",
"description": "Domain to list users from (defaults to primary domain)"
},
"maxResults": {
"type": "number",
"default": 100,
"description": "Maximum number of results to return (1-500)"
},
"orderBy": {
"type": "string",
"enum": [
"email",
"familyName",
"givenName"
],
"description": "Sort order for results"
},
"query": {
"type": "string",
"description": "Search query (e.g., \"name:John*\" or \"orgUnitPath=/Engineering\")"
},
"pageToken": {
"type": "string",
"description": "Token for paginating through results"
}
},
"required": [
"PCID"
]
}
google-workspace-admin_update_user
Update an existing user in Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userKey | string | Yes | — | User’s primary email address or unique ID |
updates | object | Yes | — | Updates to apply (e.g., {“name”: {“givenName”: “John”}, “suspended”: false}) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"userKey": {
"type": "string",
"description": "User's primary email address or unique ID"
},
"updates": {
"type": "object",
"additionalProperties": true,
"description": "Updates to apply (e.g., {\"name\": {\"givenName\": \"John\"}, \"suspended\": false})"
}
},
"required": [
"PCID",
"userKey",
"updates"
]
}
google-workspace-admin_delete_user
Delete a user from Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
userKey | string | Yes | — | User’s primary email address or unique ID to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"userKey": {
"type": "string",
"description": "User's primary email address or unique ID to delete"
}
},
"required": [
"PCID",
"userKey"
]
}
google-workspace-admin_create_group
Create a new group in Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
email | string | Yes | — | Email address for the group |
name | string | Yes | — | Name of the group |
description | string | No | — | Description of the group |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"email": {
"type": "string",
"description": "Email address for the group"
},
"name": {
"type": "string",
"description": "Name of the group"
},
"description": {
"type": "string",
"description": "Description of the group"
}
},
"required": [
"PCID",
"email",
"name"
]
}
google-workspace-admin_get_group
Get detailed information about a specific group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID"
}
},
"required": [
"PCID",
"groupKey"
]
}
google-workspace-admin_list_groups
List all groups in the Google Workspace organization with optional filtering
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
domain | string | No | — | Domain to list groups from (defaults to primary domain) |
customer | string | No | — | Customer ID (defaults to my_customer) |
maxResults | number | No | 100 | Maximum number of results to return (1-200) |
pageToken | string | No | — | Token for paginating through results |
userKey | string | No | — | Filter groups by user’s email or ID (groups they belong to) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"domain": {
"type": "string",
"description": "Domain to list groups from (defaults to primary domain)"
},
"customer": {
"type": "string",
"description": "Customer ID (defaults to my_customer)"
},
"maxResults": {
"type": "number",
"default": 100,
"description": "Maximum number of results to return (1-200)"
},
"pageToken": {
"type": "string",
"description": "Token for paginating through results"
},
"userKey": {
"type": "string",
"description": "Filter groups by user's email or ID (groups they belong to)"
}
},
"required": [
"PCID"
]
}
google-workspace-admin_update_group
Update an existing group in Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID |
updates | object | Yes | — | Updates to apply (e.g., {“name”: “New Name”, “description”: “New description”}) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID"
},
"updates": {
"type": "object",
"additionalProperties": true,
"description": "Updates to apply (e.g., {\"name\": \"New Name\", \"description\": \"New description\"})"
}
},
"required": [
"PCID",
"groupKey",
"updates"
]
}
google-workspace-admin_delete_group
Delete a group from Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID to delete |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID to delete"
}
},
"required": [
"PCID",
"groupKey"
]
}
google-workspace-admin_add_user_to_group
Add a user to a group in Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID |
userEmail | string | Yes | — | User’s email address to add |
role | string | No | "MEMBER" | Role for the user in the group |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID"
},
"userEmail": {
"type": "string",
"description": "User's email address to add"
},
"role": {
"type": "string",
"enum": [
"OWNER",
"MANAGER",
"MEMBER"
],
"default": "MEMBER",
"description": "Role for the user in the group"
}
},
"required": [
"PCID",
"groupKey",
"userEmail"
]
}
google-workspace-admin_remove_user_from_group
Remove a user from a group in Google Workspace
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID |
memberKey | string | Yes | — | Member’s email address or unique ID to remove |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID"
},
"memberKey": {
"type": "string",
"description": "Member's email address or unique ID to remove"
}
},
"required": [
"PCID",
"groupKey",
"memberKey"
]
}
google-workspace-admin_list_group_members
List all members of a specific group
Parameters:
| Parameter | Type | Required | Default | Description |
|---|
groupKey | string | Yes | — | Group’s email address or unique ID |
maxResults | number | No | 100 | Maximum number of results to return (1-200) |
pageToken | string | No | — | Token for paginating through results |
roles | string | No | — | Comma-separated list of roles to filter by (e.g., “OWNER,MANAGER”) |
{
"type": "object",
"properties": {
"PCID": {
"type": "string",
"description": "Pink Connect ID"
},
"groupKey": {
"type": "string",
"description": "Group's email address or unique ID"
},
"maxResults": {
"type": "number",
"default": 100,
"description": "Maximum number of results to return (1-200)"
},
"pageToken": {
"type": "string",
"description": "Token for paginating through results"
},
"roles": {
"type": "string",
"description": "Comma-separated list of roles to filter by (e.g., \"OWNER,MANAGER\")"
}
},
"required": [
"PCID",
"groupKey"
]
}
