Users

This context is a container, holding all User contexts (user accounts).

Unique Actions

[?]

New User Account

This Call Function action is used to create a new user account. The following parameters are specified:

Field	Description
Username	Username for both account and the user context. Read-only value once the account is created
Password	Password to associate with the account.
Repeat Password	Repeat the password to confirm and ensure accuracy during user creation.
Initialization Password	If selected, the user will be prompted to change the password after the first successful login.
Use External Authentication	If selected, Iotellect will attempt to use an External Authentication method during the Authentication and Authorization Sequence.
Permissions for Owned Resources	Permission level the user will have for resources that they own.
Permissions for Default Administrator’s Resources	Permission level the user will have for resources owned by the default administrator
Permissions for Global Resources	Permission level the user will have for global resources that doesn't belong to any users
First Name	Specifies the first name.
Last Name	Specifies the last name.
Ignore Connection Mode	Defines whether to disregard connection modes during the user creation process.
Country	Sets the country information.
Region/State/Province/Area	Specifies the region or state.
ZIP/Postal Code	Specifies the zip code or postal code.
City	Sets the city information.
Address 1	Specifies the primary address.
Address 2	Specifies additional address details.
Comments	Allows for adding comments or notes during the user creation process.
Company	Specifies the company or associated organization.
Department	Sets the department information.
E-mail Address	Specifies the user email address.
Phone No.	Sets the phone number.
Fax No.	Specifies the fax number.
Time Zone	User's time zone settings, used to show correct time for this user. Also, Devices registered under account are assumed to be located in this time zone if no time zone is explicitly specified in the Device Account.
Preferred Locale	User's locale setting identified by a two-letter country code that affects various user interface parameters.
Date Pattern	Date pattern defines how date values are formatted when shown to the user.
Time Pattern	Time pattern defines how time values are formatted when shown to the user.
Week Start Day	Controls the first day of week displayed in calendar. Possible options are Sunday or Monday.

The above permission levels will not be directly preserved inside newly created user accounts. Instead, those levels will be used to initially fill user's permissions table.

See the users section for more information about the default settings for a new account.

The create action can be only called as an Interactive action from the UI.

Action Type:	Call Function
Action Name:	create
Action Icon:
Non-Interactive Mode:	Not Supported

View User Summary

This action shows the basic properties of all user accounts that are accessible by the user executing it.

Action Type:	Call Function
Action Name:	list

Create New User Account

This action starts an Interactive Guide for helping with registering new user account.

Action Name:	guide
Action Icon:
Non-Interactive Mode:	Not Supported
Permissions:	Accessible at Administrator permission level

Common Actions

[?]

Create From Template, Replicate To Children, Import, Export, Edit Context Permissions, Monitor Related Events, Search/Filter, various Grouped Actions according to child contexts.

Context States and Icons

This context has no states. It is always represented by the icon.

Advanced Information

Context Information

Context Type: users

Context Name: users

Context Description: Users

Context Path: users

Context Mask: users

Context Permissions

[?]

Level	Description
None	No access allowed.
Observer	No access allowed.
Operator	No access allowed.
Manager	No access allowed.
Engineer	No access allowed.
Administrator	All operations.

Public Variables (Properties)

[?]

This context has no public variables (properties).

Public Functions

[?]

User List

This function returns information about all User Accounts that are accessible with current permissions. Account properties are described here.

Function Name:	list
Permissions:	Accessible at Observer permission level
Input Records:	0
Input Format:	None
Output Records:	0...unlimited
Output Format:	Name	Type	Description
	name	String
	firstname	String	Nullable
	lastname	String	Nullable
	password	String
	country	Integer
	region	String	Nullable
	zip	String	Nullable
	city	String	Nullable
	address1	String	Nullable
	address2	String	Nullable
	comments	String	Nullable
	company	String	Nullable
	department	String	Nullable
	email	String	Nullable
	phone	String	Nullable
	fax	String	Nullable
	timezone	String
	locale	String
	datepattern	String
	timepattern	String
	dsautoregistration	Boolean

Public Events

[?]

Common Events: info (Information)

This event is generated upon successful user authentication.

Event Name	login
Permissions:	Accessible at Administrator permission level
Expiration Period:	100 days
Records:	1

Record Format:

Field Name	Field Type	Notes
username	String	Name of authenticated user.
type	String	Connection type (desktop, web, web service, etc.)
address	String	Client's IP address or host name.
permissions	String	User's permissions at the moment of authentication.
login	String	Login by which the user has logged in. This value may be different from the username. This field is used for external authentication.
sessionExpirationTime	Date	Date and time when the access token of the user will expire, defined by the Web Server configuration property Access Token Expiration Period at the time of login.

Logout

This event is generated when a user logs out from the system.

Event Name	logout
Permissions:	Accessible at Administrator permission level
Expiration Period:	100 days
Records:	1