UserMgrLogout (FUN) ¶ FUNCTION UserMgrLogout : RTS_IEC_RESULT Logout specified by the user InOut: Scope Name Type Comment Return UserMgrLogout RTS_IEC_RESULT Error code ERR_OK: User is available and logout succeeded ERR_PARAMETER: If user is not available ERR_INVALID_HANDLE: hUser is invalid or unknown Input hUser RTS_IEC_HANDLE Handle to the user
UserMgrRelogin (FUN) ¶ FUNCTION UserMgrRelogin : RTS_IEC_RESULT Re-logs user in to the runtime system using an active user management. Using this API it is possible to change the user identity of the given handle. If the given credentials are not valid, no change will be done. InOut: Scope Name Type Comment Return UserMgrRelogin RTS_IEC_RESULT Error code ERR_OK: User/password combination is valid ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_RELOGIN: hUser known, but not logged in ERR_FAILED: Password is wrong. ERR_USER_MISMATCH: User name does not match ERR_INVALID_HANDLE: hUser is invalid or unknown Input hUser RTS_IEC_HANDLE Handle to the user pszUser REFERENCE TO STRING Name of the user, limited to 59 chars pszPassword REFERENCE TO STRING Password (plain text), limited to 59 chars
Authorization ¶ UserMgrGetUserAccessRights (Function) UserMgrHasUserAccessRights (Function)
UserMgrGetUserAccessRights (FUN) ¶ FUNCTION UserMgrGetUserAccessRights : RTS_IEC_RESULT Gets user access rights on the specified object (authorization)! InOut: Scope Name Type Comment Return UserMgrGetUserAccessRights RTS_IEC_RESULT Error code ERR_OK: If user has the requested rights on the object or if no user management is configured ERR_PARAMETER: If user is not available or the object does not exist ERR_FAILED: If something failed retrieving the access rights ERR_NO_ACCESS_RIGHTS: Explicitly denied rights ERR_INVALID_HANDLE: hUser is invalid or unknown Input pszObject REFERENCE TO STRING Full object name (see object tree) hUser RTS_IEC_HANDLE Handle to the user pulRights POINTER TO DWORD Pointer to get admitted rights pulDeniedRights POINTER TO DWORD Pointer to get denied rights. Note If the required right is denied _and_ admitted on the specified object, the denied right is more significant and so the access must be denied !!
UserMgrHasUserAccessRights (FUN) ¶ FUNCTION UserMgrHasUserAccessRights : RTS_IEC_RESULT Checks user access rights on the specified object (authorization)! InOut: Scope Name Type Comment Return UserMgrHasUserAccessRights RTS_IEC_RESULT Error code ERR_OK: If user has the requested rights on the object or if no user management is configured ERR_PARAMETER: If user is not available or the object does not exist ERR_FAILED: If something failed retrieving the access rights ERR_NO_ACCESS_RIGHTS: Explicitly denied rights ERR_INVALID_HANDLE: hUser is invalid or unknown Input pszObject REFERENCE TO STRING Full object name (see object tree) hUser RTS_IEC_HANDLE Handle to the user ulRequestedRights DWORD Requested rights on that object
Grouphandling ¶ UserMgrGroupAdd (Function) UserMgrGroupAddUser (Function) UserMgrGroupGetFirst (Function) UserMgrGroupGetFirstUser (Function) UserMgrGroupGetHandle (Function) UserMgrGroupGetName (Function) UserMgrGroupGetNext (Function) UserMgrGroupGetNextUser (Function) UserMgrGroupRemove (Function) UserMgrGroupRemoveUser (Function)
CmpUserMgr Library Documentation ¶ Company System Title CmpUserMgr Version 3.5.17.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library provides access to the user management. The user management in the runtime system is based on ACL (Access Control Lists). Here we have Users and UserGroups and access rights on objects. Every object in the runtime system, that must be protected with access rights, is registered dynamically during startup of the runtime by the corresponding component under the appropriate folder. The objects in the runtime system are organized as a tree with 2 root nodes: - Runtime system object : "Device" |----- "PlcLogic" |----------- "Application" |----- "Logger" |----- "Settings" |----- "UserManagement" - File system objects : "/" |----- "Temp" |----------- "Test.txt" On every object there are assigned all user groups. And for every user group you can specify the appropriate access rights. There are 5 different access rights that can be specified at every group for each object: - USERDB_RIGHT_NONE: Access denied - USERDB_RIGHT_VIEW: Only view rights on the object. Object cannot be modified in any case! - USERDB_RIGHT_MODIFY: Object can be viewed and modified - USERDB_RIGHT_EXECUTE: Object can be executed - USERDB_RIGHT_ADD_REMOVE: It is allowed to add and remove objects or sub objects - USERDB_RIGHT_ALL: All rights allowed on the object Not every access right is retrieved by an object. Which access rights are used are specified by each object and are masked in the user rights editor in the programming system! Indices and tables ¶ 1 Based on CmpUserMgr.library, last modified 20.04.2021, 15:58:15. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 20.04.2021, 15:58:15.
Library Reference ¶ This is a dictionary of all referenced libraries and their name spaces. CmpUserMgr Implementation ¶ Library Identification ¶ Placeholder: CmpUserMgr Implementation Default Resolution: CmpUserMgr Implementation, * (System) Namespace: CmpUserMgr_Implementation Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr Implementation CmpUserMgr Interfaces ¶ Library Identification ¶ Name: CmpUserMgr Interfaces Version: newest Company: System Namespace: CmpUserMgr_Interfaces Library Properties ¶ LinkAllContent: False Optional: False PublishSymbolsInContainer: True QualifiedOnly: False SystemLibrary: False Key: CmpUserMgr Interfaces, * (System)
File and Project Information ¶ Scope Name Type Content FileHeader creationDateTime date 20.04.2021, 15:58:15 companyName string 3S-Smart Software Solutions GmbH libraryFile CmpUserMgr.library primaryProject True productName CODESYS productProfile CODESYS V3.5 SP16 Patch 3 contentFile CmpUserMgr.clean.json version version 2.0.0.0 ProjectInformation IsContainerLibrary bool True IsEndUserLibrary False Released True SourceLibrary False LastModificationDateTime date 20.04.2021, 15:58:15 LibraryCategories library-category-list System|SysLibs Author string CODESYS Development GmbH Company System CompiledLibraryCompatibilityVersion CODESYS V3.5 SP16 DefaultNamespace Description See: Description DocFormat reStructuredText Project CmpUserMgr Title CmpUserMgr Version version 3.5.17.0
CmpUserMgr Interfaces Library Documentation ¶ Company System Title CmpUserMgr Interfaces Version 3.5.19.0 Categories System|SysLibs Author CODESYS Development GmbH Description 1 ¶ This library contains the constants used by the CmpUserMgr component. Contents: ¶ CmpUserMgr GlobalConstants Structs Types Indices and tables ¶ 1 Based on CmpUserMgr_Itfs.library, last modified 02.03.2023, 11:03:11. LibDoc 4.4.0.0-b.27 The content file CmpUserMgr_Itfs.clean.json was generated with CODESYS V3.5 SP16 Patch 3 on 02.03.2023, 11:03:13.
