THthingsboard
user-controller

Get User (getUserById)

Fetch the User object based on the provided User Id. If the user has the authority of 'SYS_ADMIN', the server does not perform additional checks. If the user has the authority of 'TENANT_ADMIN', the server checks that the requested user is owned by the same tenant. If the user has the authority of 'CUSTOMER_USER', the server checks that the requested user is owned by the same customer.

get/api/user/{userId}

Request

Path parameters

userIdstring required

A string value representing the user id. For example, '784f394c-42b6-435a-983c-b7beff2784f9'

Response

OK

createdTimeinteger

Timestamp of the user creation, in milliseconds

emailstring required

Email of the user

authority'SYS_ADMIN' | 'TENANT_ADMIN' | 'CUSTOMER_USER' | 'REFRESH_TOKEN' | 'PRE_VERIFICATION_TOKEN' | 'MFA_CONFIGURATION_TOKEN' required

Authority

firstNamestring

First name of the user

lastNamestring

Last name of the user

phonestring

Phone number of the user

versioninteger
namestring

Duplicates the email of the user, readonly

additionalInfounknown

Example response

{
  "id": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "USER"
  },
  "createdTime": 1609459200000,
  "tenantId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "TENANT"
  },
  "customerId": {
    "id": "784f394c-42b6-435a-983c-b7beff2784f9",
    "entityType": "CUSTOMER"
  },
  "email": "user@example.com",
  "authority": "SYS_ADMIN, TENANT_ADMIN or CUSTOMER_USER",
  "firstName": "John",
  "lastName": "Doe",
  "name": "user@example.com",
  "additionalInfo": {}
}

Changes

No recorded changes to this operation across all 2 revisions of this API.