Property | Type | Description | Mandatory |
|---|---|---|---|
email | String | The email assigned to this user to be entered during login. The email is unique per Application. | Y |
username | String | Enter any user name to be used by IoT Platform . This property is used for display, not for logging in. | Y |
tenantId | String | The ID of the IoT Platform Tenant to which this user belongs. This identifier is automatically generated by IoT Platform and is returned in response to the Tenants/Post request. | |
password | String | The password provided by IoT Platform is mandatory for creating new users. For security reasons, IoT Platform does not store the password on its servers. Instead, the password is stored in an external secure password system. This password is not returned in any GET requests. | Y |
role | String | Specifies the type of user as well as their associated permissions – • Admin ‒ Has full access to all IoT Platform functionality for all the Applications of all the Tenants to which this user is assigned. • Readonly ‒ Can only view IoT Platform data. • AppAdmin ‒ Can access almost all functionality for the Application to which he/she is assigned. For example, cannot create new devices. • TenantTechSupport ‒ Can access almost all functionality for the Tenant assigned to him/her, including creating new Devices and new Rules. This role is typically assigned to technical support at the customer. | Y |
mobilePhone | String | Alerts can trigger a phone call or can send an SMS. This is the cell phone number to contact when an alert is triggered. | |
cultureInfo | String | The language in which the IoT Platform portal is presented. These standard options include the language of the Application and are described at https://msdn.microsoft.com/en-us/library/system.globalization.cultureinfo(vs.71).aspx. | |
status | String/Enum | User status – • Pending ‒ User that has a pending invitation to IoT Platform . See the Users/Invite request. Only invited users can be pending. • Activated ‒ User that is authorized by IoT Platform . • Blocked ‒ User with repeated unsuccessful login attempts. The default number of attempts is 3. | |
isScrubbed | Boolean | An internal property used by IoT Platform for GDPR purposes. | |
failedLogins | Integer | Specifies the number of failed logins since the user last logged in successfully. | |
favouriteReports | String Array | Lists the report IDs that were defined as favorites of this user in the IoT Platform Portal, as described in xxx. |