Click or drag to resize

Authentication Methods

The Authentication type exposes the following members.

Methods
 NameDescription
Public methodStatic memberActiveDirectoryLogin Active directory login to system.

Requires minimum firmware version 1.601.0017

Public methodStatic memberActiveDirectoryLogout Active directory logout from system
Public methodStatic memberAddGroupToSystem(AuthenticationUserToken, String, AuthenticationUserAuthenticationLevelEnum)Obsolete.
Add group to system
Public methodStatic memberAddGroupToSystem(AuthenticationUserToken, String, AuthenticationUserAuthenticationLevelEnum) Add group to system
Public methodStatic memberAddUserToGroup(AuthenticationUserToken, String, String)Add user to group
Public methodStatic memberAddUserToGroup(AuthenticationUserToken, String, String, String)Obsolete.
Add user to group
Public methodStatic memberAddUserToGroup(AuthenticationUserToken, String, String, String)Add user to group
Public methodStatic memberAddUserToSystem(AuthenticationUserToken, String, String)Obsolete.
add user to system
Public methodStatic memberAddUserToSystem(AuthenticationUserToken, String, String) add user to system
Public methodStatic memberDisable(AuthenticationUserToken) Method to disable authentication on the control system.

SSL state and user information will remain in their current state.

Public methodStatic memberDisable(AuthenticationUserToken, Boolean) Method to disable authentication on the control system.
Public methodStatic memberDisable(AuthenticationUserToken, Boolean, Boolean) Method to disable authentication on the control system.
Public methodStatic memberEnable Method to enable authentication on the control system.
Public methodStatic memberGetAccessLevelForSpecifiedUser Method to return the access level of the specified user. This returns AuthenticationUserAuthenticationLevelEnum indicating the access level.
Public methodStatic memberGetAuthenticationToken(String, String) Get authentication token for this user. For use for administering local groups and users or once a domain has been added.
Public methodStatic memberGetAuthenticationToken(String, String, String) Get authentication token for the specified user from the provided IPAddress.

IP address will be blocked if invalid user login attempts exceeds the set value.

Public methodStatic memberGetAuthenticationToken(String, String, String, String) Get authentication token for the local user and validate the given domain user.
Public methodStatic memberGetGroups Method to return the current list of groups and each of its access level in this system.

Requires minimum firmware version 1.601.0017

Public methodStatic memberGetGroupsForSpecifiedUser Method to return the groups that the specified user belongs to. This returns AuthenticationUserAuthenticationLevelEnum containing the groups.
Public methodStatic memberGetUsers Method to return the current list of users that have access to this system.

Requires minimum firmware version 1.502.0009

Public methodStatic memberReleaseAuthenticationToken This function releases the authentication token, obtained by calling the GetAuthentication method.
Public methodStatic memberRemoveGroupFromSystem(AuthenticationUserToken, String)Obsolete.
Remove an access group from the system
Public methodStatic memberRemoveGroupFromSystem(AuthenticationUserToken, String) Remove an access group from the system
Public methodStatic memberRemoveUserFromGroup(AuthenticationUserToken, String, String)Obsolete.
Remove a user account from an access group
Public methodStatic memberRemoveUserFromGroup(AuthenticationUserToken, String, String) Remove a user account from an access group
Public methodStatic memberRemoveUserFromSystem(AuthenticationUserToken, String)Obsolete.
Remove a user account from the control system list of users
Public methodStatic memberRemoveUserFromSystem(AuthenticationUserToken, String) Remove a user account from the control system list of users
Public methodStatic memberSetUserPageAuthentication Method to enable or disable user page authentication.
Public methodStatic memberUpdatePassword(AuthenticationUserToken, String, String) Method to update the password for a specified local user.
Public methodStatic memberUpdatePassword(AuthenticationUserToken, String, String, String) Method to update the password for a specified local user.
Public methodStatic memberValidatePassword(String, AuthenticationePasswordRules, String) Validate a password satisfies all system cuurent password rules
Public methodStatic memberValidatePassword(String, String, AuthenticationePasswordRules, String) Validate a password satisfies all system cuurent password rules
Public methodStatic memberValidateUserInformation Return information about the specified user information
Top
See Also