Weaviate users API
The users API from Weaviate — 6 operation(s) for users.
Weaviate users API is one of 22 APIs that Weaviate publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and a getting-started guide.
This API exposes 8 operations across 6 paths, and defines 7 schemas. It is described by OpenAPI 3.0.3, at version 1.38.0-dev.
Requests are made against a single base URL, http://localhost:8080.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
Weaviate users API declares
2 security schemes
for authenticating requests.
An API key is passed in the header as Authorization (ApiKeyAuth).
It accepts HTTP bearer tokens (JWT) (BearerAuth).
By default, every request must be authenticated.
ApiKeyAuth— API key authenticationBearerAuth— OIDC/JWT bearer authentication
Paths & Operations 8
Across 6 paths, the API surfaces 8 operations — 1 DELETE, 3 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 7
The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are Permission (12 properties), DBUserInfo (8 properties), UserOwnInfo (3 properties), Role (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Weaviate 12
Other APIs Weaviate publishes across the network.