IPWorks Auth 2020 Node.js Edition

Questions / Feedback?

User Property

The user.

Syntax

 ntlm.getUser([callback])
 ntlm.setUser( user, [callback])

Default Value

""

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 getUser([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 setUser([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

This property specifies the name and realm/domain of the user. The value specified must be in one of the following formats:

  • user
  • domain/user

Data Type

String

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Auth 2020 Node.js Edition - Version 20.0 [Build 8155]