Zitadel Users API
Manage human and machine users
Zitadel Users API is one of 11 APIs that Zitadel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 13 JSON Schema definitions.
Tagged areas include Users. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a GitHub repository, and 13 JSON Schemas.
This API exposes 11 operations across 10 paths, and defines 17 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://{instance}.zitadel.cloud, https://{custom-domain}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Zitadel Users API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
Paths & Operations 11
Across 10 paths, the API surfaces 11 operations — 1 DELETE, 1 GET, 8 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Manage human and machine users
Schemas 17
The contract defines 17 schemas that model the data the API accepts and returns. The most detailed are HumanProfile (7 properties), User (7 properties), CreateHumanUserRequest (6 properties), HumanUser (5 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 Zitadel 10
Other APIs Zitadel publishes across the network.