Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kurrent Users API

User account management

Kurrent Users API is one of 9 APIs that Kurrent 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, an API reference, and authentication docs.

This API exposes 9 operations across 6 paths, and defines 2 schemas. It is described by OpenAPI 3.1.0, at version v26.1.

Requests are made against a single base URL, https://{host}:{port}.

9 operations 6 paths 2 schemas 1 DELETE2 GET3 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v26.1
Base URL
https://docs.kurrent.io/server/v26.1/http-api/api.html
Authentication
HTTP Basic
Contact
Resource Areas
1

Authentication & Security 1

Kurrent Users API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basicAuth). By default, every request must be authenticated.

  • basicAuth — KurrentDB supports HTTP Basic authentication for the HTTP API, with access control lists (ACLs) applied per stream. See https://docs.kurrent.io/server/v26.1/ht…

Paths & Operations 9

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

Users 9

User account management

GET
/users/
List all users
listUsers → 200401
POST
/users/
Create a user
createUser body → 201400401
GET
/users/{login}
Get the details of a user
getUser 1 param → 200401404
PUT
/users/{login}
Update a user
updateUser 1 param body → 200400401
DELETE
/users/{login}
Delete a user
deleteUser 1 param → 204401404
PUT
/users/{login}/command/enable
Enable a user account
enableUser 1 param → 200401404
PUT
/users/{login}/command/disable
Disable a user account
disableUser 1 param → 200401404
POST
/users/{login}/command/reset-password
Reset the password of a user
resetUserPassword 1 param body → 200400401
POST
/users/{login}/command/change-password
Change the password of a user
changeUserPassword 1 param body → 200400401

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are NewUser (4 properties), UserUpdate (2 properties). Each schema is shown below with its type and property counts.

UserUpdate
object
Updated details of a user account
2 properties
NewUser
object
A user account to create
4 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kurrent-users-api-openapi.yml Raw ↑

Other APIs Kurrent publishes across the network.

KurrentDB gRPC API
Kurrent Admin API
Kurrent Gossip API
Kurrent Info API
Kurrent Projections API
Kurrent Statistics API
Kurrent Streams API
Kurrent Subscriptions API