An User instance resource represents a single user entity.
Tip
System users are personas who interact with the platform in order to develop an IIoT solution or monitor the system. System users should not be confused with users typically defined by your solution's domain.
Resource Attributes
Attribute | Description |
---|---|
id | A 23 to 26 characters long string that uniquely identifies this user. |
accountId | The unique id of the account that created this user. |
The email address of the user. Since emails must be unique across the system, email can be used as entity name in URL paths like .../users/[email protected] . | |
name | Full name of the user. |
status | The status of this user. Can be either invited , confirmed and disabled . Users with invited and disabled status cannot access to the platform. |
role | The role assigned to the user. Can be either admin , user (regular user), power (power user), guest , and custom . |
description | Optional. Some description about this user. |
tags | Optional. The list of the tags associated with the user. |
avatarUrl | Optional. URL for the avatar image. |
timezone | Optional. The time zone for this user in [City] UTC±[hh][mm] format. |
locale | Optional. Preferred language and locale for this user in [language code]-[country] format. |
locked | if locked, entity cannot be modified, deleted. |
dateCreated | The date that this user was created in ISO 8601 format. |
dateModified | The date that this user was last modified in ISO 8601 format. |
{
"id": "_usr_587617400839897384",
"accountId": "_acc_587617399162687551",
"email": "[email protected]",
"name": "Michael Stevenson",
"status": "confirmed",
"role": "admin",
"description": "Account owner",
"tags": ["r&d", "developer"],
"avatarUrl": "http://s3.content.avatars.com/images/minime.jpg",
"timezone": "Vancouver UTC-08:00",
"locale": "en-ca",
"dateCreated": "2016-03-21T18:10:52.882Z",
"dateModified": "2016-03-23T19:32:38.681Z"
}