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 auth API

The auth API from IOTA — 2 operation(s) for auth.

IOTA auth API is one of 17 APIs that IOTA publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, /.

2 operations 2 paths 3 schemas 1 GET1 POST

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 auth API declares 1 security scheme for authenticating requests. An API key is passed in the header as Authorization (Authorization).

  • Authorization — JWT Token

Paths & Operations 2

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

auth 2
POST
/auth
Authenticate towards the node
authenticate body → 200401405
GET
/auth/info
Get information about the current authentication mode
authInfo → 200

Schemas 3

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

LoginRequest
object
2 properties 2 required
AuthInfoModel
object
2 properties 2 required
LoginResponse
object
2 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

iota-auth-api-openapi.yml Raw ↑

Other APIs IOTA publishes across the network.

IOTA GraphQL 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
IOTA requests API