AuthMechanism Property

The authentication mechanism to be used when connecting to the LDAP server.

Syntax

 ldap.getAuthMechanism([callback])
 ldap.setAuthMechanism( authMechanism, [callback])

Possible Values

  0 (amSimple), 
  1 (amDigestMD5), 
  2 (amNegotiate), 
  6 (amKerberos)

Default Value

0

Callback

The 'callback' parameter specifies a function which will be called when the operation completes (or an error is encountered). If the 'callback' parameter is not specified, then the method will block and will not return until the operation completes (or an error is encountered).

The callback for the getAuthMechanism([callback]) method is defined as:

function(err, data){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'data' is the value returned by the method.

The callback for the setAuthMechanism([callback]) method is defined as:

function(err){ }

'err' is the error that occurred. If there was no error, then 'err' is 'null'.

'err' has 2 properties which hold detailed information:

err.code
err.message

Remarks

By default, AuthMechanism is amSimple (0), and default plaintext authentication is used to login to the server. If AuthMechanism is set to amDigestMD5 (1), the more secure DIGEST-MD5 authentication is used instead.

If AuthMechanism is set to amNegotiate (2) NTLM/Negotiate authentication will be used.

If AuthMechanism is set to amKerberos (6) Kerberos/Negotiate authentication will be used.

Data Type

Integer