How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

ThingsBoard user-controller API

User

ThingsBoard user-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 user-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.

This API exposes 26 operations across 20 paths, and defines 14 schemas. It is described by OpenAPI 3.2.0, at version 4.3.0.3DEMO.

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

26 operations 20 paths 14 schemas 4 DELETE15 GET5 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.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 user-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 26

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

user-controller 26

User

GET
/api/user/settings
Get User Settings (getUserSettings)
getUserSettings → 200
PUT
/api/user/settings
Update User Settings (saveUserSettings)
putUserSettings body → 200
POST
/api/user/settings
Save User Settings (saveUserSettings)
saveUserSettings body → 200
GET
/api/user/settings/{type}
Get User Settings (getUserSettings)
getUserSettings_1 1 param → 200
PUT
/api/user/settings/{type}
Update User Settings (saveUserSettings)
putUserSettings_1 1 param body → 200
POST
/api/user
Save or Update User (saveUser)
saveUser 1 param body → 200
POST
/api/user/{userId}/userCredentialsEnabled
Enable/Disable User Credentials (setUserCredentialsEnabled)
setUserCredentialsEnabled 2 params → 200
POST
/api/user/sendActivationMail
Send or Re-send the Activation Email
sendActivationEmail 1 param → 200
GET
/api/user/mobile/session
getMobileSession 1 param → 200
POST
/api/user/mobile/session
saveMobileSession 1 param body → 200
DELETE
/api/user/mobile/session
removeMobileSession 1 param → 200
GET
/api/users
Get Users (getUsers)
getUsersByIds 6 params → 200
GET
/api/users/info
Find Users by Query (findUsersByQuery)
findUsersByQuery 5 params → 200
GET
/api/users/assign/{alarmId}
Get UsersForAssign (getUsersForAssign)
getUsersForAssign 6 params → 200
GET
/api/user/{userId}
Get User (getUserById)
getUserById 1 param → 200
DELETE
/api/user/{userId}
Delete User (deleteUser)
deleteUser 1 param → 200
GET
/api/user/{userId}/token
Get User Token (getUserToken)
getUserToken 1 param → 200
GET
/api/user/{userId}/activationLink
Get Activation Link (getActivationLink)
getActivationLink 1 param → 200
GET
/api/user/{userId}/activationLinkInfo
Get Activation Link Info (getActivationLinkInfo)
getActivationLinkInfo 1 param → 200
GET
/api/user/tokenAccessEnabled
Check Token Access Enabled (isUserTokenAccessEnabled)
isUserTokenAccessEnabled → 200
GET
/api/user/dashboards
Get Information About Last Visited and Starred Dashboards (getLastVisitedDashboards)
getUserDashboardsInfo → 200
GET
/api/user/dashboards/{dashboardId}/{action}
Report Action of User Over the Dashboard (reportUserDashboardAction)
reportUserDashboardAction 2 params → 200
GET
/api/tenant/{tenantId}/users
Get Tenant Users (getTenantAdmins)
getTenantAdmins 6 params → 200
GET
/api/customer/{customerId}/users
Get Customer Users (getCustomerUsers)
getCustomerUsers 6 params → 200
DELETE
/api/user/settings/{type}/{paths}
Delete User Settings (deleteUserSettings)
deleteUserSettings 2 params → 200
DELETE
/api/user/settings/{paths}
Delete User Settings (deleteUserSettings)
deleteUserSettings_1 1 param → 200

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are User (12 properties), UserEmailInfo (4 properties), PageDataUserEmailInfo (4 properties), LastVisitedDashboardInfo (4 properties). Each schema is shown below with its type and property counts.

UserActivationLink
object
2 properties
UserId
object
2 properties 2 required
TenantId
object
2 properties 2 required
UserDashboardsInfo
object
2 properties
StarredDashboardInfo
object
3 properties
PageDataUser
object
4 properties
User
object
A JSON value representing the User.
12 properties 2 required
JsonNode
A value representing the any type (object or primitive)
MobileSessionInfo
object
1 property
JwtPair
object
JWT Pair
3 properties
LastVisitedDashboardInfo
object
4 properties
PageDataUserEmailInfo
object
4 properties
CustomerId
object
2 properties 2 required
UserEmailInfo
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-user-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 auth-controller API
ThingsBoard calculated-field-controller API
ThingsBoard component-descriptor-controller API
ThingsBoard customer-controller API
Where this information came from

This is an independent, third-party profile of ThingsBoard user-controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.