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

Weka User API

The User API from Weka — 7 operation(s) for user.

Weka User API is one of 45 APIs that Weka publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include User. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 9 operations across 7 paths, and defines 2 schemas. It is described by OpenAPI 3.0.3, at version 5.1.

Requests are made against a single base URL, /api/v2.

9 operations 7 paths 2 schemas 2 DELETE2 GET2 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
5.1
Base URL
https://api.docs.weka.io/api/v2
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Weka User API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). By default, every request must be authenticated.

Paths & Operations 9

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

User 9
GET
/users
Get all local users
getUsers 2 params → 200401
POST
/users
Create a new local user
createUser body → 200400401
PUT
/users/{uid}
Update user details
updateUser 1 param body → 200400401404
DELETE
/users/{uid}
Delete a local user
deleteUser 1 param → 200401404
PUT
/users/password
Change user password
updateUserPassword body → 200400401
PUT
/users/{uid}/password
Set user password (admin)
setUserPassword 1 param body → 200400401
GET
/users/whoami
Get current user information
whoAmI → 200401
DELETE
/users/{uid}/revoke
Revoke all user sessions
revokeUser 1 param → 200401404
POST
/users/{uid}/s3/resetCredentials
Reset S3 API credentials
resetUserS3Credentials 1 param body → 200400401404

Schemas 2

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

user
object
8 properties
userRole
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

weka-user-api-openapi.yml Raw ↑

Other APIs Weka publishes across the network.

Weka Active Directory API
Weka Alerts API
Weka Catalog API
Weka Cluster API
Weka Containers API
Weka DataService API
Weka Default network API
Weka Drive API
Weka Events API
Weka Failure domains API
Weka Filesystem API
Weka Filesystem group API