Authentication Methods |
The Authentication type exposes the following members.
| Name | Description | |
|---|---|---|
| ActiveDirectoryLogin |
Active directory login to system.
Requires minimum firmware version 1.601.0017 | |
| ActiveDirectoryLogout | Active directory logout from system | |
| AddGroupToSystem(AuthenticationUserToken, String, AuthenticationUserAuthenticationLevelEnum) | Obsolete. Add group to system | |
| AddGroupToSystem(AuthenticationUserToken, String, AuthenticationUserAuthenticationLevelEnum) | Add group to system | |
| AddUserToGroup(AuthenticationUserToken, String, String) | Add user to group | |
| AddUserToGroup(AuthenticationUserToken, String, String, String) | Obsolete. Add user to group | |
| AddUserToGroup(AuthenticationUserToken, String, String, String) | Add user to group | |
| AddUserToSystem(AuthenticationUserToken, String, String) | Obsolete. add user to system | |
| AddUserToSystem(AuthenticationUserToken, String, String) | add user to system | |
| Disable(AuthenticationUserToken) |
Method to disable authentication on the control system.
SSL state and user information will remain in their current state. | |
| Disable(AuthenticationUserToken, Boolean) | Method to disable authentication on the control system. | |
| Disable(AuthenticationUserToken, Boolean, Boolean) | Method to disable authentication on the control system. | |
| Enable | Method to enable authentication on the control system. | |
| GetAccessLevelForSpecifiedUser | Method to return the access level of the specified user. This returns AuthenticationUserAuthenticationLevelEnum indicating the access level. | |
| GetAuthenticationToken(String, String) | Get authentication token for this user. For use for administering local groups and users or once a domain has been added. | |
| GetAuthenticationToken(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. | |
| GetAuthenticationToken(String, String, String, String) | Get authentication token for the local user and validate the given domain user. | |
| GetGroups |
Method to return the current list of groups and each of its access level in this system.
Requires minimum firmware version 1.601.0017 | |
| GetGroupsForSpecifiedUser | Method to return the groups that the specified user belongs to. This returns AuthenticationUserAuthenticationLevelEnum containing the groups. | |
| GetUsers |
Method to return the current list of users that have access to this system.
Requires minimum firmware version 1.502.0009 | |
| ReleaseAuthenticationToken | This function releases the authentication token, obtained by calling the GetAuthentication method. | |
| RemoveGroupFromSystem(AuthenticationUserToken, String) | Obsolete. Remove an access group from the system | |
| RemoveGroupFromSystem(AuthenticationUserToken, String) | Remove an access group from the system | |
| RemoveUserFromGroup(AuthenticationUserToken, String, String) | Obsolete. Remove a user account from an access group | |
| RemoveUserFromGroup(AuthenticationUserToken, String, String) | Remove a user account from an access group | |
| RemoveUserFromSystem(AuthenticationUserToken, String) | Obsolete. Remove a user account from the control system list of users | |
| RemoveUserFromSystem(AuthenticationUserToken, String) | Remove a user account from the control system list of users | |
| SetUserPageAuthentication | Method to enable or disable user page authentication. | |
| UpdatePassword(AuthenticationUserToken, String, String) | Method to update the password for a specified local user. | |
| UpdatePassword(AuthenticationUserToken, String, String, String) | Method to update the password for a specified local user. | |
| ValidatePassword(String, AuthenticationePasswordRules, String) | Validate a password satisfies all system cuurent password rules | |
| ValidatePassword(String, String, AuthenticationePasswordRules, String) | Validate a password satisfies all system cuurent password rules | |
| ValidateUserInformation | Return information about the specified user information |