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

ThingsBoard auth-controller API

Auth

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

This API exposes 11 JSON Schema definitions.

Tagged areas include auth-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 9 operations across 7 paths, and defines 11 schemas. It is described by OpenAPI 3.1.0, at version 4.3.0.3DEMO.

Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.

9 operations 7 paths 11 schemas 4 GET5 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
4.3.0.3DEMO
Servers
https://demo.thingsboard.io
http://localhost:8080
Authentication
HTTP Loginpassword, API Key
License
Resource Areas
1

Authentication & Security 2

ThingsBoard auth-controller API declares 2 security schemes for authenticating requests. It uses HTTP loginpassword authentication (HTTP login form). An API key is passed in the header as X-Authorization (API key form).

  • HTTP login form — Enter Username / Password
  • API key form — Enter the API key value with 'ApiKey' prefix in format: ApiKey Example: ApiKey tb5te51SkLRYpjGrujUGwqkjFvooWBlQpVe2An2Dr3w13wjfxDW NOTE: Use only ONE authentic…

Paths & Operations 9

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

auth-controller 9

Auth

GET
/api/noauth/resetPassword
Check Password Reset Token (checkResetToken)
checkResetToken 1 param → 200
POST
/api/noauth/resetPassword
Reset Password (resetPassword)
resetPassword body → 200
POST
/api/noauth/resetPasswordByEmail
Request Reset Password Email (requestResetPasswordByEmail)
requestResetPasswordByEmail body → 200
GET
/api/noauth/activate
Check Activate User Token (checkActivateToken)
checkActivateToken 1 param → 200
POST
/api/noauth/activate
Activate User
activateUser 1 param body → 200
POST
/api/auth/logout
Logout (logout)
logout → 200
POST
/api/auth/changePassword
Change Password for Current User (changePassword)
changePassword body → 200
GET
/api/noauth/userPasswordPolicy
Get the Current User Password Policy (getUserPasswordPolicy)
getUserPasswordPolicy → 200
GET
/api/auth/user
Get Current User (getUser)
getUser → 200

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are User (12 properties), UserPasswordPolicy (10 properties), JwtPair (3 properties), ActivateUserRequest (2 properties). Each schema is shown below with its type and property counts.

ActivateUserRequest
object
Activate user request.
2 properties
JsonNode
A value representing the any type (object or primitive)
UserId
object
2 properties 2 required
TenantId
object
2 properties 2 required
User
object
A JSON value representing the User.
12 properties 2 required
ChangePasswordRequest
object
Change Password Request
2 properties
ResetPasswordEmailRequest
object
The JSON object representing the reset password email request.
1 property
CustomerId
object
2 properties 2 required
UserPasswordPolicy
object
10 properties
JwtPair
object
JWT Pair
3 properties
ResetPasswordRequest
object
Reset password request.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-auth-controller-api-openapi.yml Raw ↑

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
ThingsBoard ai-model-controller API
ThingsBoard alarm-comment-controller API
ThingsBoard alarm-controller API
ThingsBoard api-key-controller API
ThingsBoard asset-controller API
ThingsBoard asset-profile-controller API
ThingsBoard audit-log-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API
ThingsBoard dashboard-controller API