Skip to content

Commit 141c887

Browse files
authored
Merge pull request dotnet#9372 from liveans/credentials-doc-side-effect
Document the behavior of side effect on UseDefaultCredentials property
2 parents 19eb2ec + c269ec4 commit 141c887

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

xml/System.Net.Http/HttpClientHandler.xml

+10-1
Original file line numberDiff line numberDiff line change
@@ -482,7 +482,14 @@ On .NET Core, the key usage attribute on the X509 certificate, if present, is re
482482
<Docs>
483483
<summary>Gets or sets authentication information used by this handler.</summary>
484484
<value>The authentication credentials associated with the handler. The default is <see langword="null" />.</value>
485-
<remarks>To be added.</remarks>
485+
<remarks>
486+
<format type="text/markdown"><![CDATA[
487+
488+
## Remarks
489+
490+
If the <xref:System.Net.Http.HttpClientHandler.UseDefaultCredentials> property has been set to `true`, it has a side effect on this property, and this property will be set to <xref:System.Net.CredentialCache.DefaultCredentials>.
491+
]]></format>
492+
</remarks>
486493
</Docs>
487494
</Member>
488495
<Member MemberName="DangerousAcceptAnyServerCertificateValidator">
@@ -1451,6 +1458,8 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA
14511458
Set this property to `true` when requests made by the <xref:System.Net.Http.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 <xref:System.Net.Http.HttpClientHandler.Credentials%2A> property to the credentials of the client on whose behalf the request is made.
14521459
14531460
This property doesn't affect proxy credentials. When the default (system) proxy is being used, set credentials explicitly by using the <xref:System.Net.Http.HttpClientHandler.DefaultProxyCredentials> property. When the proxy is set by the <xref:System.Net.Http.HttpClientHandler.Proxy> property, set credentials for the proxy via its <xref:System.Net.IWebProxy.Credentials> property.
1461+
1462+
If this property has been set to `true` then, it has a side effect on <xref:System.Net.Http.HttpClientHandler.Credentials> property, and <xref:System.Net.Http.HttpClientHandler.Credentials> will be set to <xref:System.Net.CredentialCache.DefaultCredentials>.
14541463
]]></format>
14551464
</remarks>
14561465
</Docs>

0 commit comments

Comments
 (0)