User

 Top  Previous  Next

This context lets you access and manage a single user account.

Unique Actions [?]

Configure (Default Action)

This  action is used to edit account properties.

Action Type:

Configure

Delete Account

This is a standard Delete action that is used to remove user account.

Action Name:

delete

Action Icon:

cm_delete

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 st_user 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: Observer

Public Variables (Properties) [?]

Common Variables: groupMembership (Group Membership)

USER INFORMATION

Returns properties of a User Account.

Variable Name:

childInfo

Records:

1

Permissions:

Readable at Observer permission level

Record 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

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

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.

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)