HttpClientHandler.PreAuthenticate Property

Definition

Gets or sets a value that indicates whether the handler sends an Authorization header with the request.

C#
public bool PreAuthenticate { get; set; }
C#
[System.Runtime.Versioning.UnsupportedOSPlatform("browser")]
public bool PreAuthenticate { get; set; }

Property Value

true for the handler to send an HTTP Authorization header with requests after authentication has taken place; otherwise, false. The default is false.

Attributes

Remarks

After a client request to a specific Uri is successfully authenticated, if the PreAuthenticate property is true and credentials are supplied, HttpClientHandler matches against the credential list supplied in the Credentials property. The Authorization header is sent with each request to any Uri that matches the specific Uri up to the last forward slash.

If the client request to a specific Uri is not successfully authenticated, the request uses standard authentication procedures.

With the exception of the first request, the PreAuthenticate property indicates whether to send authentication information with subsequent requests to a Uri that matches the specific Uri up to the last forward slash without waiting to be challenged by the server.

Applies to

Product Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9, 10
.NET Framework 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 1.1, 1.2, 1.3, 1.4, 1.6, 2.0, 2.1
UWP 10.0