How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Google Workspace

Google Workspace Users API

Manage user accounts in a Google Workspace domain

Documentation Provider Profile APIs.io OpenAPI GitHub

Google Workspace Users API is one of 29 APIs that Google Workspace publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, an API reference, a getting-started guide, and 1 JSON Schema.

This API exposes 9 operations across 5 paths, and defines 4 schemas. It is described by OpenAPI 3.2.0, at version directory_v1.

Requests are made against a single base URL, https://admin.googleapis.com.

9 operations 5 paths 4 schemas 1 DELETE2 GET1 PATCH4 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
directory_v1
Base URL
https://gmail.googleapis.com
Authentication
OAuth 2.0
Contact
Google Workspace Developer Support
License
Google APIs Terms of Service
Resource Areas
1

Authentication & Security 1

Google Workspace Users API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (oauth2) using the authorizationCode flow, exposing 6 scopes. By default, every request must be authenticated.

  • oauth2 — OAuth 2.0 authorization for Google Workspace Admin operations.

Paths & Operations 9

Across 5 paths, the API surfaces 9 operations — 1 DELETE, 2 GET, 1 PATCH, 4 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Users 9

Manage user accounts in a Google Workspace domain

GET
/admin/directory/v1/users
List Users
listUsers 11 params → 200400401403
POST
/admin/directory/v1/users
Create a User
insertUser body → 200400401403409
GET
/admin/directory/v1/users/{userKey}
Get a User
getUser 4 params → 200401403404
PUT
/admin/directory/v1/users/{userKey}
Update a User
updateUser 1 param body → 200400401403404
PATCH
/admin/directory/v1/users/{userKey}
Patch a User
patchUser 1 param body → 200400401403404
DELETE
/admin/directory/v1/users/{userKey}
Delete a User
deleteUser 1 param → 204401403404
POST
/admin/directory/v1/users/{userKey}/makeAdmin
Make a User a Super Administrator
makeUserAdmin 1 param body → 204401403404
POST
/admin/directory/v1/users/{userKey}/undelete
Undelete a User
undeleteUser 1 param body → 204401403404
POST
/admin/directory/v1/users/{userKey}/signOut
Sign Out a User
signOutUser 1 param → 204401403404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are User (42 properties), Users (5 properties), UserName (4 properties), Error (1 property). Each schema is shown below with its type and property counts.

Users
object
A paginated list of user resources.
5 properties
UserName
object
A user name object containing given, family, and full name.
4 properties 2 required
User
object
A Google Workspace user account. JSON representation of a user resource from the Admin SDK Directory API.
42 properties 2 required
Error
object
An error response from the API.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

google-workspace-users-api-openapi.yml Raw ↑

Other APIs Google Workspace publishes across the network.

Gmail API
AE Profile APIs.io
Google Drive API
AE Profile APIs.io
Google Calendar API
AE Profile APIs.io
Google Meet REST API
AE Profile APIs.io
Google Docs API
AE Profile APIs.io
Google Sheets API
AE Profile APIs.io
Google Slides API
AE Profile APIs.io
Google Chat API
AE Profile APIs.io
Admin SDK Reports API
AE Profile APIs.io
Google Forms API
AE Profile APIs.io
Google Tasks API
AE Profile APIs.io
Google Keep API
AE Profile APIs.io
#User
← Back to G APIs
API Details
ID
google-workspace:google-workspace-users-api
Base URL
https://gmail.googleapis.com
Docs
https://developers.google.com/gmail/api
Provider
Google Workspace
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=google-workspace-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/google-workspace-users-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of Google Workspace Users API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.