User Object

Describes the JSON object of a User.

A User in Ubidots has over the entities (variables, devices, etc) contained in the Organization(s) the User belongs to. Users have a password-protected account and can access the entities based on the particular Role through an App.

Property

Type

Description

url

String

URL of User

id

String

Id of User

username

String

Username of User

firstName

String

First name of User

lastName

String

Last name of User

email

String

Email of User

defaultOrganization

Object

Default Organization of User, including: url, id, label, name and created_at. (each field is a string)

defaultRole

Object

Default Role of User, including: url, label, name and created_at (each field is a string)

defaultDashboard

Object

Default dashboard of User, including: url, id, label, name and created_at. (each field is a string)

language

String

Language of User

website

String

Website of User

timezone

String

Timezone of User

decimalPlaces

Integer

Decimal places of User

numberFormat

String

Number format of User

firstTime

Boolean

True if User has been logged

properties

Object

Properties of Users, including support for:

  • deactivation_timestamp: Deactivation time of the user.
  • send_invitation: Send invitation to user after creation.
  • is_historic_data_deleted: Historical data deleted.
  • password_update_timestamp: Timestamp for password update.

isActive

Boolean

True if User is active

lastLogin

String

Last login of User

tags

List

Tags of User

createdAt

String

Date User was created

contactMethods

List of objects

Contact methods of User, including support for:

  • id: id of User contact method.
  • type: type of contact method. Options: email, voice, telegram or sms.
  • values: list of numbers or emails.
  • properties: object of properties. Defaults to {}

mugshotUrl

String

Icon of User (Read only, on-demand)

organizations

Array

Organizations of User (Read only, on-demand)

organizationsCount

Integer

Number of Organizations of User (Read only, on-demand)

User

{
    "url": "https://industrial.api.ubidots.com/api/v2.0/users/65fda649e4404f02d1a86cbf",
    "id": "65fda649e4404f02d1a86cbf",
    "username": "Azure",
    "firstName": "Ubidots",
    "lastName": "IoT",
    "email": "[email protected]",
    "defaultOrganization": {
        "url": "https://industrial.api.ubidots.com/api/v2.0/organizations/64a5f0c5dde0bc007aa7bdb5",
        "id": "64a5f0c5dde0bc007aa7bdb5",
        "label": "test-ubidots",
        "name": "Ubidots",
        "createdAt": "2023-07-05T22:37:57.721000Z"
    },
    "defaultRole": {
        "url": "https://industrial.api.ubidots.com/api/v2.0/roles/admin",
        "label": "admin",
        "name": "Admin",
        "createdAt": "2023-07-12T19:08:40.847000Z"
    },
    "defaultDashboard": {
        "url": "https://industrial.api.ubidots.com/api/v2.0/dashboards/65c2fec389f8ab000eae12c3",
        "id": "65c2fec389f8ab000eae12c3",
        "label": "test-dashboard",
        "name": "Test dashboard",
        "createdAt": "2024-02-07T03:53:39.501598Z"
    },
    "language": null,
    "website": "https://es.ubidots.com/",
    "timezone": null,
    "decimalPlaces": 2,
    "numberFormat": null,
    "firstTime": true,
    "properties": {
        "password_update_timestamp": 1711121993410
    },
    "isActive": true,
    "lastLogin": "2024-04-05T22:02:52.052973Z",
    "tags": [
        "tag1",
        "tag2"
    ],
    "createdAt": "2024-03-22T15:39:53.277583Z",
    "contactMethods": [
        {
            "id": "661075c55e660d000d2e02b1",
            "type": "voice",
            "values": [
                "+57 3301124451"
            ],
            "properties": {}
        },
        {
            "id": "661075c55e660d000d2e02b2",
            "type": "telegram",
            "values": [
                "+57 3301124451"
            ],
            "properties": {}
        },
        {
            "id": "661075c55e660d000d2e02af",
            "type": "email",
            "values": [
                "[email protected]"
            ],
            "properties": {}
        },
        {
            "id": "661075c55e660d000d2e02b0",
            "type": "sms",
            "values": [
                "+57 3301124451"
            ],
            "properties": {}
        }
    ]
}

📘

mugshotUrl, organizations and organizationsCount

Fields on demand