UserManagement

[ Class ]

Provides functions for user management.

Depending on the group rights of the current user, some user management functions may not be permitted. In this case the functions return an error message. The function getApiAccess can be used to notify the user in advance (for example by hiding input fields).

The configuration of the current user can be accessed via the function TcHmi.Server.getCurrentUserConfig().

Static functions

addUser

Creates a new user.

addUserEx

Creates a new user.

listUsernames

Supplies a list of all existing system users.

listUsernamesEx

Supplies a list of all existing system users.

listUsers

Supplies a list of all existing system users as object with all metadata.

listUsersEx

Supplies a list of all existing system users as object with all metadata.

listUserGroups

Supplies a list of all existing system groups as object with all metadata.

listUserGroupsEx

Supplies a list of all existing system groups as object with all metadata.

listUsersInGroup

Supplies a list of all existing users in a group.

listUsersInGroupEx

Supplies a list of all existing users in a group.

removeUser

Deletes a user.

removeUserEx

Deletes a user.

updateUser

Modifies a user.

updateUserEx

Modifies a user.

getApiAccess

Returns a list of currently available API functions.

Interfaces

IUserDetails

Saves metadata of a user.

 

IGroupDetails

Saves metadata of a group.

 

IUpdateUserDetails

Change details of the metadata of a user.

 

IUsernameListResultObject

Saves a list of user names.

 

IUserResultObject

Result of a ListUsers call.

 

IGroupResultObject

Result of a ListUserGroups call.

 

IApiAccessResultObject

Result of a GetApiAccess call.

 

IUserManagementOptions

UserManagement options

UserManagement 1:

Available from version 1.10.1018.48