Skip to content

Document the behavior of side effect on UseDefaultCredentials property #9372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
liveans merged 3 commits into from
Oct 5, 2023
Merged

Document the behavior of side effect on UseDefaultCredentials property #9372

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
61ce8fa
Document the behavior of side effect on UseDefaultCredentials property
Oct 4, 2023
39c4c53
Update HttpClientHandler.xml
Oct 4, 2023
c269ec4
Update xml/System.Net.Http/HttpClientHandler.xml
Oct 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 10 additions & 1 deletion xml/System.Net.Http/HttpClientHandler.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -482,7 +482,14 @@ On .NET Core, the key usage attribute on the X509 certificate, if present, is re
<Docs>
<summary>Gets or sets authentication information used by this handler.</summary>
<value>The authentication credentials associated with the handler. The default is <see langword="null" />.</value>
<remarks>To be added.</remarks>
<remarks>
<format type="text/markdown"><![CDATA[

## Remarks

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>.
]]></format>
</remarks>
</Docs>
</Member>
<Member MemberName="DangerousAcceptAnyServerCertificateValidator">
Expand Down Expand Up @@ -1451,6 +1458,8 @@ handler.ServerCertificateCustomValidationCallback = HttpClientHandler.DangerousA
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.

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.

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>.
]]></format>
</remarks>
</Docs>
Expand Down