AuthScheme Property

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

Syntax

public int getAuthScheme();
public void setAuthScheme(int authScheme);


Enumerated values:
  public final static int authBasic = 0;
  public final static int authDigest = 1;
  public final static int authProprietary = 2;
  public final static int authNone = 3;
  public final static int authNtlm = 4;
  public final static int authNegotiate = 5;
  public final static int authFormBased = 6;
  public final static int authSPOnline = 7;

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 component 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 component 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 component 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.

Default Value

7