Authentication ¶ UserMgrChangeMyPassword (Function) UserMgrGetSessionUser (Function) UserMgrIsActive (Function) UserMgrLogin (Function) UserMgrLogout (Function) UserMgrRelogin (Function)

UserMgrChangeMyPassword (FUN) ¶ FUNCTION UserMgrChangeMyPassword : RTS_IEC_RESULT Changes the users password InOut: Scope Name Type Comment Return UserMgrChangeMyPassword RTS_IEC_RESULT Error code ERR_OK: Password changed successfully ERR_NOTINITIALIZED: The user management is not initialized or it is not loaded yet ERR_OPERATION_DENIED: Password change is either not supported or not allowed 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 pszOldPassword REFERENCE TO STRING Old password (plain text), limited to 59 chars pszNewPassword REFERENCE TO STRING New password (plain text), limited to 59 chars

UserMgrGetSessionUser (FUN) ¶ FUNCTION UserMgrGetSessionUser : RTS_IEC_HANDLE Retrieves the user handle assigned to a CODESYS online session. InOut: Scope Name Type Comment Return UserMgrGetSessionUser RTS_IEC_HANDLE Handle of the user or RTS_INVALID_HANDLE if not available. Input sessionId UDINT Session id of which the user handle should be read. pResult POINTER TO RTS_IEC_RESULT Pointer to error code. One of: ERR_OK: User is available ERR_NOTINITIALIZED: The session management is not initialized ERR_NO_OBJECT: The session is not available

UserMgrIsActive (FUN) ¶ FUNCTION UserMgrIsActive : BOOL Checks if the user management is active. InOut: Scope Name Type Comment Return UserMgrIsActive BOOL TRUE: The user management is activated or enforced. FALSE: The user management is not activated.

UserMgrLogin (FUN) ¶ FUNCTION UserMgrLogin : RTS_IEC_HANDLE Logs user in to the runtime system requiring an active user management. InOut: Scope Name Type Comment Return UserMgrLogin RTS_IEC_HANDLE Handle to the user or RTS_INVALID_HANDLE if not available Input pszUser REFERENCE TO STRING Name of the user, limited to 59 chars pszPassword REFERENCE TO STRING Password (plain text), limited to 59 chars pResult POINTER TO RTS_IEC_RESULT Pointer to error code ERR_OK: User/password combination is valid ERR_ACTIVATE_USERMGMT: The login was successful. But the user management is enforced and not active. Activate the user management. ERR_CHANGE_PASSWORD: The login was successful. But the user must change his password. ERR_NO_USERMGMT: Login was not successful. The user management is not activated. Use empty user and password to login. ERR_NO_ACCESS_RIGHTS: The login was not successful, because of another reason.

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