User
This context lets you access and manage a single user account.
Unique Actions
[?]
Configure
This action is used to edit account properties.
Action Type: |
Delete Account
This is a standard Delete action that is used to remove user account.
Action Name: | delete |
Action Icon: |  |
Non-Interactive Mode: | Supported |
Permissions: | Accessible at Administrator permission level |
Common Actions
[?]
Replicate, Edit Context Permissions, Monitor Related Events, View Status
Context States and Icons
This context has no states. It is always represented by the 
icon.
Advanced Information |
Context Information
Context Type: user
Context Name: provided by user
Context Description: provided by user; contains username, first name and last name of a user
Context Path: users.USER_NAME
Context Mask: users.*
Context Permissions
[?]
Level | Description |
None | No access allowed. |
Observer | Basic event monitoring. Status browsing. |
Operator | Configuration browsing. |
Manager | User profile browsing. User photo editing. |
Engineer | Same as Manager. |
Administrator | User profile editing. User permissions editing. User removal. |
Public Variables (Properties)
[?]
Common Variables: groupMembership (Group Membership), activeAlerts (Active Alerts)
User Information
Returns properties of a User Account.
Variable Name: | childInfo |
Records: | 1 |
Permissions: | Accessible at Manager permission level |
Record Format:
Name | Type | Description |
name | String |
|
firstname | String | Nullable |
lastname | String | Nullable |
password | String |
|
initializationPassword | String |
|
ignoreConnectionMode | Boolean |
|
useExternalAuthentication | Boolean |
|
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 |
String | Nullable | |
phone | String | Nullable |
fax | String | Nullable |
timezone | String |
|
locale | String |
|
datepattern | String |
|
timepattern | String |
|
dsautoregistration | Boolean |
|
Permissions
Returns permissions of a User Account.
Variable Name: | permissions |
Records: | 0...unlimited |
Permissions: | Readable at Observer permission level, writable at Administrator permission level |
Record Format:
Field Name | Field Type | Notes |
mask | String | Context mask for that permission level is applied. |
type | String | Permission level. |
Account Settings
User account settings.
Variable Name: | settings |
Records: | 1 |
Permissions: | Readable/writable at Administrator permission level |
Record Format:
Field Name | Field Type | Notes |
connectionRestrictionExpression | String |
|
enabled | Boolean | User login is not allowed if this flag is disabled. |
activationTime | Date | If not NULL, user is not allowed to log in until this time. |
expirationTime | Date | If not NULL, user is not allowed to log in after this time. |
inheritPermissions | Boolean |
|
inheritPermissionsUser | String |
|
useRoleBasedPermissions | Boolean |
|
Resources
User's available resources table.
Variable Name: | resources |
Records: | 0...unlimited |
Permissions: | Readable/writable at Administrator permission level |
Record Format:
Field Name | Field Type | Notes |
description | String | Resource type description. |
available | Boolean | Flag indicating whether user's account will have a container node for resources of this type. |
User Photo
User's photo.
Variable Name: | photo |
Records: | 1 |
Permissions: | Readable/writable at Manager permission level |
Record Format:
Field Name | Field Type | Notes |
photo | Data Block |
|
User Status
Returns status of a User Account.
Variable Name: | status |
Records: | 1 |
Permissions: | Readable at Observer permission level |
Record Format:
Field Name | Field Type | Notes |
creationtime | Date | Account creation time. |
updatetime | Date | Last account modification time. |
logintime | Date | Last login time, or NULL if the user has never logged in. |
Public Functions
[?]
Delete User Account
Permanently destroys User Account and all related data.
Function Name: | delete |
Permissions: | Accessible at Administrator permission level |
Input Records: | 0 |
Input Format: | None |
Output Records: | 0 |
Output Format: | none |
Public Events
[?]
Common Events: info (Information)
Was this page helpful?