HttpClientHandler.UseDefaultCredentials Property

Definition

Namespace:

System.Net.Http

Assembly:

System.Net.Http.dll

Source:

HttpClientHandler.cs

Gets or sets a value that controls whether default credentials are sent with requests by the handler.

public:
 property bool UseDefaultCredentials { bool get(); void set(bool value); };

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

[<System.Runtime.Versioning.UnsupportedOSPlatform("browser")>]
member this.UseDefaultCredentials : bool with get, set

Public Property UseDefaultCredentials As Boolean

Property Value

Boolean

true if the default credentials are used; otherwise false. The default value is false.

Attributes

UnsupportedOSPlatformAttribute

Remarks

Set this property to true when requests made by the HttpClientHandler object should, if requested by the server, be authenticated using the credentials of the currently logged on user. For client applications, this is the desired behavior in most scenarios. For middle-tier applications, such as ASP.NET applications, instead of using this property, you would typically set the Credentials property to the credentials of the client on whose behalf the request is made.

This property doesn't affect proxy credentials. When the default (system) proxy is being used, set credentials explicitly by using the DefaultProxyCredentials property. When the proxy is set by the Proxy property, set credentials for the proxy via its Credentials property.

If this property has been set to true then, it has a side effect on Credentials property, and Credentials will be set to DefaultCredentials.