Click or drag to resize

AuthenticationActiveDirectoryLogin Method

Active directory login to system.

Requires minimum firmware version 1.601.0017


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

Parameters

utoken  AuthenticationUserToken
Local user token obtained using "GetAuthenticationToken" method passed as reference. ADConnect member of utoken will be updated if user could login to AD server.
domain  String
Domain to be logged in to the system
username  String
User to be logged in the system
password  String
Password for logged in to be added

Return Value

Boolean
Returns true if domain user was able to login successfully.

Returns false if user token is invalid or unable to connect or login successfully to the Active Directory server.

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.
SystemExceptionUnable to update token or login to Active Directory.
NotSupportedExceptionActive Directory Login is not supported on this platform. Use DevicePlatform to determine the running platform type.

Version Information

.NET

Supported in: 6.0

.NET Compact Framework

Supported in: 3.5
See Also