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

IOTA users API

The users API from IOTA — 4 operation(s) for users.

IOTA users API is one of 17 APIs that IOTA 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 an API reference.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.1, at version 0.

Requests are made against a single base URL, /.

6 operations 4 paths 5 schemas 1 DELETE2 GET1 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
0
Base URL
https://api.mainnet.iota.cafe:443
Authentication
API Key
Resource Areas
1

Authentication & Security 1

IOTA users API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT Token

Paths & Operations 6

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

users 6
GET
/v1/users
Get a list of all users
getUsers → 200401
POST
/v1/users
Add a user
addUser body → 201400401
DELETE
/v1/users/{username}
Deletes a user
deleteUser 1 param → 200401404
GET
/v1/users/{username}
Get a user
getUser 1 param → 200401404
PUT
/v1/users/{username}/password
Change user password
changeUserPassword 1 param body → 200400401404
PUT
/v1/users/{username}/permissions
Change user permissions
changeUserPermissions 1 param body → 200400401404

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are AddUserRequest (3 properties), ValidationError (2 properties), User (2 properties), UpdateUserPermissionsRequest (1 property). Each schema is shown below with its type and property counts.

AddUserRequest
object
3 properties 3 required
UpdateUserPasswordRequest
object
1 property 1 required
User
object
2 properties 2 required
ValidationError
object
2 properties 2 required
UpdateUserPermissionsRequest
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iota-users-api-openapi.yml Raw ↑

Other APIs IOTA publishes across the network.

IOTA GraphQL API
IOTA auth API
IOTA chains API
IOTA Coin Query API
IOTA corecontracts API
IOTA Extended API
IOTA Governance API
IOTA Health API
IOTA metrics API
IOTA Move Utils API
IOTA node API
IOTA Read API