Skip to main content

Google Workspace

Manage Workspace directory users, groups, and group memberships through the Google Admin SDK Directory API, including admin roles, custom user schemas, calendar resources, and devices.

Categories: Identity and Access, Productivity

Set up​

Google Workspace needs an OAuth application from your organization before anyone can connect. An organization admin completes these steps once.

  1. Go to Organization > Connectors and find Google Workspace. Click Enable, and choose which tools to allow.
  2. Create an OAuth application in the Google Workspace developer portal.
  3. Add the Redirect URI shown in the connector settings to the application.
  4. Copy the application's Client ID and Client Secret into the connector, then save it.
  5. Each member connects their own account the first time they use it.

⚠️ Warning: Do not enter your Devs.ai or Google Workspace login email or password in the OAuth application fields.

To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.

OAuth scopes used by these tools (11)

Grant the scopes for the tools you plan to allow.

  • https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly
  • https://www.googleapis.com/auth/admin.directory.device.mobile.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.orgunit
  • https://www.googleapis.com/auth/admin.directory.orgunit.readonly
  • https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly
  • https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly
  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/admin.directory.userschema.readonly

Tools​

Google Workspace offers 34 tools. Admins choose which ones agents can use. See Tool permission groups.

Read (21)​

View and search information without changing it.

ToolWhat it does
get_calendar_resourceGet one calendar resource (room or equipment) by immutable ID, with its capacity, location and features.
get_chromeos_deviceGet one managed ChromeOS device by immutable ID: status, model, OS and firmware versions, assigned user and org unit.
get_groupGet a Workspace group by email address or immutable ID.
get_memberGet one Workspace group membership by group and member email or immutable ID.
get_mobile_deviceGet one user-owned mobile device by resource ID: owner, model, OS, status, last sync and compromise status.
get_org_unitGet one organizational unit by full path or immutable ID.
get_roleGet one admin role by immutable ID, with its privileges and whether it is a system or super admin role.
get_schemaGet one custom user schema by name or immutable ID, with its fields, types and who can read them.
get_userGet a Workspace user by primary email or immutable user ID.
has_memberCheck whether a user is a member of a Workspace group, directly or through a nested group.
list_calendar_resourcesList bookable calendar resources such as meeting rooms and equipment, filtered by building, floor, capacity or category.
list_chromeos_devicesList managed ChromeOS devices with status, model, OS version, last sync and assigned user.
list_groupsList Workspace groups by customer, member, or Google Directory query, with pagination.
list_membersList direct members of a Workspace group, optionally filtering by role.
list_mobile_devicesList user-owned mobile devices (Android, iOS, Google Sync) registered with the account, with owner, model, OS, status and last sync.
list_org_unitsList organizational units under a path, or from the root.
list_role_assignmentsList which users and groups hold admin roles.
list_rolesList admin roles, both Google's predefined and custom ones, without privileges (use get_role for those, or fields='rolePrivileges').
list_schemasList the custom user schemas defined for the account, with their fields and types.
list_usersList Workspace domain users with Directory query filters and page tokens.
validate_credentialValidate Google Workspace Directory API access by listing one user.

Write (4)​

Create or send data.

ToolWhat it does
add_memberAdd an existing Workspace user or group to a group with the specified role.
create_groupCreate a Workspace group.
create_org_unitCreate an organizational unit under an existing parent; use parent_org_unit_path '/' for a top-level unit.
create_userCreate a Workspace user account.

Delete or overwrite (9)​

Remove or replace existing data.

ToolWhat it does
delete_groupDelete a Workspace group and its group address.
delete_org_unitDelete an organizational unit permanently.
delete_userDelete a Workspace user account.
remove_memberRemove a user or group from a Workspace group.
undelete_userRestore a recently deleted Workspace user to an organizational unit.
update_groupPatch a Workspace group's properties, such as name or description.
update_memberChange an existing member's Workspace group role.
update_org_unitRename an organizational unit, change its description, or move it under another parent.
update_userPatch a Workspace user's Directory fields, such as suspended, name, or orgUnitPath.
⌘J