IFPCWebListenerProperties::BasicAuthentication property

Article
08/27/2012

Applies to: desktop apps only

The BasicAuthentication property gets or sets a Boolean value that indicates whether Basic authentication is used.

This property is read/write.

Syntax

HRESULT put_BasicAuthentication(
  VARIANT_BOOL fBasicAuthentication
);

HRESULT get_BasicAuthentication(
  VARIANT_BOOL *pfBasicAuthentication
);

' Data type: Boolean

Property BasicAuthentication( _
  ByVal fBasicAuthentication As VARIANT_BOOL, _
  ByVal pfBasicAuthentication As VARIANT_BOOL _
) As Boolean

Property value

Boolean value that indicates whether Basic authentication is used.

Error codes

These property methods return S_OK if the call is successful; otherwise, they return an error code.

Remarks

This property is read/write. Its default value is False (VARIANT_FALSE in C++).

The standard Hypertext Transfer Protocol (HTTP) method of authentication is Basic authentication. Basic authentication sends and receives user information as text characters that can be easily read. Although passwords and user names are encoded, no encryption is used with Basic authentication. The following describes the authentication procedure for Basic authentication:

The client prompts the user for credentials, which consist of a user name and password.
The credentials are then encoded by the client and sent to the server.
The user name is verified as being an account on the Forefront TMG computer or in a trusted domain of the Forefront TMG computer.

Basic authentication can be enabled for a Web listener together with Digest authentication, Integrated authentication, and SSL certificate authentication.

Requirements

Minimum supported client	Windows Vista
Minimum supported server	Windows Server 2008 R2, Windows Server 2008 with SP2 (64-bit only)
Version	Forefront Threat Management Gateway (TMG) 2010
IDL	Msfpccom.idl
DLL	Msfpccom.dll

Share via