ThingsBoard

ThingsBoard User Controller API

User

Documentation GitHub OpenAPI

Business capability

Identity & Access Management BC-620.20

Operations 26

GET /api/user/settings Get User Settings (getUserSettings) #

PUT /api/user/settings Update User Settings (saveUserSettings) #

POST /api/user/settings Save User Settings (saveUserSettings) #

GET /api/user/settings/{type} Get User Settings (getUserSettings) #

PUT /api/user/settings/{type} Update User Settings (saveUserSettings) #

POST /api/user Save or Update User (saveUser) #

POST /api/user/{userId}/userCredentialsEnabled Enable/Disable User Credentials (setUserCredentialsEnabled) #

POST /api/user/sendActivationMail Send or Re-send the Activation Email #

GET /api/user/mobile/session Get mobile session #

POST /api/user/mobile/session Save mobile session #

DELETE /api/user/mobile/session Remove mobile session #

GET /api/users Get Users (getUsers) #

GET /api/users/info Find Users by Query (findUsersByQuery) #

GET /api/users/assign/{alarmId} Get UsersForAssign (getUsersForAssign) #

GET /api/user/{userId} Get User (getUserById) #

DELETE /api/user/{userId} Delete User (deleteUser) #

GET /api/user/{userId}/token Get User Token (getUserToken) #

GET /api/user/{userId}/activationLink Get Activation Link (getActivationLink) #

GET /api/user/{userId}/activationLinkInfo Get Activation Link Info (getActivationLinkInfo) #

GET /api/user/tokenAccessEnabled Check Token Access Enabled (isUserTokenAccessEnabled) #

GET /api/user/dashboards Get Information About Last Visited and Starred Dashboards… #

GET /api/user/dashboards/{dashboardId}/{action} Report Action of User Over the Dashboard (reportUserDashboardAction) #

GET /api/tenant/{tenantId}/users Get Tenant Users (getTenantAdmins) #

GET /api/customer/{customerId}/users Get Customer Users (getCustomerUsers) #

DELETE /api/user/settings/{type}/{paths} Delete User Settings (deleteUserSettings) #

DELETE /api/user/settings/{paths} Delete User Settings (deleteUserSettings) #

Documentation

https://thingsboard.io/docs/reference/rest-api/

https://thingsboard.io/docs/user-guide/assets/

https://thingsboard.io/docs/user-guide/telemetry/

https://thingsboard.io/docs/user-guide/alarms/

https://thingsboard.io/docs/user-guide/rule-engine-2-0/re-getting-started/

https://thingsboard.io/docs/user-guide/rpc/

https://thingsboard.io/docs/user-guide/dashboards/

https://thingsboard.io/docs/user-guide/ui/customers/

https://thingsboard.io/docs/user-guide/notifications/

https://thingsboard.io/docs/edge/

https://thingsboard.io/docs/user-guide/mobile-app/

https://thingsboard.io/docs/user-guide/lwm2m/

https://thingsboard.io/products/trendz/

Specifications

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-user-controller-api-openapi.yml

Schemas & Data

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-device-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-deviceprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-asset-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-assetprofile-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-entityrelation-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-alarm-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-rulechain-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-dashboard-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-tenant-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-customer-schema.json

https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/json-schema/thingsboard-user-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this

find_apisBrowse and filter every API in the catalog.
get_api_artifactsOne API's artifacts, grouped by type.
get_openapiThe primary OpenAPI for this API.
find_similar_apisAPIs that look like this one.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This API

curl "https://apis.io/api/v1/apis/thingsboard-user-controller-api"

All apis

curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

openapi: 3.2.0
info:
  title: ThingsBoard Tenants and Customers User Controller API
  description: 'ThingsBoard Tenants and Customers API — subset of the ThingsBoard REST API (open-source IoT platform). Covers: Tenant, Tenant Profile, Customer, User.'
  version: 4.3.0.3DEMO
  contact:
    name: ThingsBoard team
    url: https://thingsboard.io
    email: info@thingsboard.io
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
servers:
- url: https://demo.thingsboard.io
  description: ThingsBoard Live Demo
- url: http://localhost:8080
  description: Local ThingsBoard server
tags:


# --- truncated at 32 KB (33 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/thingsboard/refs/heads/main/openapi/thingsboard-user-controller-api-openapi.yml