Users

Top  Previous  Next

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

Unique Actions [?]

New User Account (Default Action)
View User Summary

Other unique actions:

TUTORIAL: CREATE NEW USER ACCOUNT

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

Action Name:

guide

Action Icon:

cm_guide

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 st_users icon.

Advanced Information

Context Information

Context Type: users

Context Name: users

Context Description: Users

Context Path: users

Context Mask: users

Context Permissions: Admin

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)

Login

This event is generated upon successful user authentication.

Event Name

login

Permissions:

Accessible at Administrator permission level

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.

Logout

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

Event Name

logout

Permissions:

Accessible at Administrator permission level

Records:

1

Record Format:

Field Name

Field Type

Notes

username

String

Name of user who performed the logout.