AuthScheme Property

The authentication scheme to be used while authenticating with the server.

Syntax

 sharepoint.getAuthScheme([callback])
 sharepoint.setAuthScheme( authScheme, [callback])

Possible Values

  0 (authBasic), 
  1 (authDigest), 
  2 (authProprietary), 
  3 (authNone), 
  4 (authNtlm), 
  5 (authNegotiate), 
  6 (authFormBased), 
  7 (authSPOnline)

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 getAuthScheme([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 setAuthScheme([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

Use the AuthScheme property to specify how to authenticate to the server.

By default, AuthScheme is set to authSPOnline(7). If AuthScheme is set to authNtlm and User and Password are empty, the class will attempt to authenticate using the current user's credentials.

AuthScheme should be set to authNone (3) when no authentication is to be performed.

Form Based Authentication

If connecting to a remotely hosted site another common form of authentication is authFormBased (6). The class will automatically retrieve the required security cookies when a method is called. To use Forms-Based Authentication, specify User, Password, URL, and set this setting to True. Not other settings are required.

The cookies will be saved in FormBasedCookies, but in most cases you will not need to query this setting.

If the cookies in FormBasedCookies become invalid, they should be cleared before re-attempting authentication.

Share Point Online

When connecting to Share Point Online set the AuthScheme to authSPOnline (7). The class will automatically retrieve the required security cookies when a method is called. To use SharePoint Online specify User, Password, and URL. No other settings are required.

The cookies will be saved in SPOnlineSecurityCookies, but in most cases you will not need to query this setting.

If the cookies in SPOnlineSecurityCookies become invalid they should be cleared before re-attempting authentication.

If Single Sign On is used, refer to SPOnlineSSO for more details.

Data Type

Integer