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
Drupal

drupal Users API

JSON:API endpoints for Drupal user entities. Config entities are read-only via JSON:API and require authentication.

Documentation Provider Profile APIs.io OpenAPI GitHub

drupal Users API is one of 9 APIs that Drupal 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, and 1 JSON Schema.

This API exposes 6 operations across 3 paths, and defines 15 schemas. It is described by OpenAPI 3.2.0, at version 1.1.

Requests are made against a single base URL, https://example.com/jsonapi.

6 operations 3 paths 15 schemas 1 DELETE3 GET2 PATCH

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.1
Base URL
https://example.com
Authentication
HTTP Basic, API Key, OAuth 2.0
Contact
Drupal Community
Terms of Service
View terms
Resource Areas
1

Authentication & Security 3

drupal Users API declares 3 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). An API key is passed in the cookie as SESS (cookieAuth). It supports OAuth 2.0 (oAuth2) using the authorizationCode flow, exposing 2 scopes. By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Drupal username and password.
  • cookieAuth — Cookie-based session authentication obtained via Drupal login.
  • oAuth2 — OAuth 2.0 via the Simple OAuth module.

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 1 DELETE, 3 GET, 2 PATCH. Each is listed below with its method, path, parameters, and response codes.

Users 6

JSON:API endpoints for Drupal user entities. Config entities are read-only via JSON:API and require authentication.

GET
/user/user
List users
listUsers 8 params → 200401403
GET
/user/user/{uuid}
Get a user
getUser 4 params → 200401403404
PATCH
/user/user/{uuid}
Update a user
updateUser 2 params body → 200400401403404
GET
/user/{id}
Get a user
getUser 2 params → 200401403404
PATCH
/user/{id}
Update a user
updateUser 2 params body → 200400401403404
DELETE
/user/{id}
Delete a user
deleteUser 1 param → 204401403404

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are User (8 properties), JsonApiCollectionLinks (5 properties), JsonApiResourceObject (5 properties), JsonApiCollection (5 properties). Each schema is shown below with its type and property counts.

User
object
A Drupal user account entity with profile and authentication information.
8 properties
StringValue
object
Drupal field value wrapper for a string value.
1 property
JsonApiResourceObject
object
A JSON:API resource object representing a single Drupal entity.
5 properties 2 required
UserInput
object
Request body for updating a Drupal user account. Include only fields to modify.
3 properties
JsonApiUpdateRequest
object
Generic JSON:API update request body.
1 property 1 required
JsonApiLinks
object
Navigation links included in JSON:API responses.
2 properties
JsonApiErrorResponse
object
A JSON:API error response containing one or more error objects.
2 properties
ErrorResponse
object
Standard error response returned for 4xx HTTP error codes.
1 property
IntegerValue
object
Drupal field value wrapper for an integer value.
1 property
JsonApiCollection
object
A JSON:API collection response containing multiple resource objects.
5 properties
JsonApiError
object
A single JSON:API error object.
4 properties
JsonApiSingleResponse
object
A JSON:API response containing a single resource object.
4 properties
JsonApiCollectionLinks
object
Pagination links for collection responses.
5 properties
BooleanValue
object
Drupal field value wrapper for a boolean value.
1 property
TargetId
object
Drupal entity reference value wrapper pointing to a related entity.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

drupal-users-api-openapi.yml Raw ↑

Other APIs Drupal publishes across the network.

Drupal GraphQL API
AE Profile APIs.io
drupal Comments API
AE Profile APIs.io
drupal Files API
AE Profile APIs.io
drupal Node Articles API
AE Profile APIs.io
drupal Node Pages API
AE Profile APIs.io
drupal Nodes API
AE Profile APIs.io
drupal Taxonomy Terms API
AE Profile APIs.io
drupal Taxonomy Vocabularies API
AE Profile APIs.io
#User
← Back to D APIs
API Details
ID
drupal:drupal-users-api
Base URL
https://example.com
Docs
https://www.drupal.org/docs/core-modules-and-themes/core-modules/restful-web-services-module
Provider
Drupal
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=drupal-users-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/drupal-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 drupal 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.