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

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 User. 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.2.0, at version 1.0.0.

Requests are made against 2 base URLs: https://{instance}.zitadel.cloud, https://{custom-domain}.

11 operations 10 paths 17 schemas 1 DELETE1 GET8 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0.0
Servers
https://{instance}.zitadel.cloud
https://{custom-domain}
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

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.

Users 11

Manage human and machine users

POST
/management/v1/users/_search
Zitadel List Users
listUsers body → 200401403
POST
/management/v1/users/human/_create
Zitadel Create Human User
createHumanUser body → 200400401
POST
/management/v1/users/machine/_create
Zitadel Create Machine User
createMachineUser body → 200401
GET
/management/v1/users/{userId}
Zitadel Get User by ID
getUserById 1 param → 200404
DELETE
/management/v1/users/{userId}
Zitadel Remove User
removeUser 1 param → 200404
POST
/management/v1/users/{userId}/deactivate
Zitadel Deactivate User
deactivateUser 1 param → 200404
POST
/management/v1/users/{userId}/reactivate
Zitadel Reactivate User
reactivateUser 1 param → 200404
POST
/management/v1/users/{userId}/lock
Zitadel Lock User
lockUser 1 param → 200
POST
/management/v1/users/{userId}/unlock
Zitadel Unlock User
unlockUser 1 param → 200
PUT
/management/v1/users/{userId}/email
Zitadel Update User Email
updateUserEmail 1 param body → 200
POST
/management/v1/users/{userId}/memberships/_search
Zitadel List User Memberships
listUserMemberships 1 param → 200

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.

UserResponse
object
1 property
CreateUserResponse
object
2 properties
Error
object
3 properties
MachineUser
object
3 properties
HumanEmail
object
2 properties
CreateHumanUserRequest
object
6 properties 1 required
CreateMachineUserRequest
object
4 properties 2 required
HumanUser
object
5 properties
ObjectDetails
object
4 properties
Membership
object
4 properties
ListUsersRequest
object
2 properties
User
object
7 properties
ListQuery
object
3 properties
ListDetails
object
3 properties
HumanPhone
object
2 properties
ListUsersResponse
object
2 properties
HumanProfile
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zitadel-users-api-openapi.yml Raw ↑

Other APIs Zitadel publishes across the network.

Zitadel Auth API
Zitadel Admin API
Zitadel OIDC / OAuth 2.0
Zitadel SAML API
Zitadel Applications API
Zitadel Identity Providers API
Zitadel Organizations API
Zitadel Policies API
Zitadel Projects API
Zitadel Roles API
Where this information came from

This is an independent, third-party profile of Zitadel 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.