Click or drag to resize

AuthenticationUpdatePassword(AuthenticationUserToken, String, String) Method

Method to update the password for a specified local user.

Namespace: Crestron.SimplSharp.CrestronAuthentication
Assembly: SimplSharpHelperInterface (in SimplSharpHelperInterface.dll) Version: 2.21.121
Syntax
C#
public static bool UpdatePassword(
	ref AuthenticationUserToken utoken,
	string username,
	string password
)

Parameters

utoken  AuthenticationUserToken
User token obtained using GetAuthenticationToken passed in as reference so that the access level gets updated dynamically
username  String
Name of the user to update the password.
password  String
New password for the user

Return Value

Boolean
true if succeeded or false otherwise
Exceptions
ExceptionCondition
InvalidOperationExceptionAuthentication is not currently enabled on the controller.
AuthenticationPrivilegeExceptionHigher privileges are required to use this method.
ArgumentExceptionArguments provided to a method is not valid.
ArgumentExceptionPassword does not satisfy current system rules.
Remarks
This API throws ArgumentException for the password on a newer firmware with password similarity check required.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also