ICredentialPolicy.ShouldSendCredential Method (Uri, WebRequest, NetworkCredential, IAuthenticationModule)


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns a Boolean that indicates whether the client's credentials are sent with a resource request made using an instance of the WebRequest class.

Namespace:   System.Net
Assembly:  System (in System.dll)

abstract ShouldSendCredential : 
        challengeUri:Uri *
        request:WebRequest *
        credential:NetworkCredential *
        authenticationModule:IAuthenticationModule -> bool


Type: System.Uri

The Uri that will receive the request. For more information, see the Remarks section.

Type: System.Net.WebRequest

The WebRequest that represents the resource being requested.

Type: System.Net.NetworkCredential

The NetworkCredential that will be sent with the request if this method returns true.

Type: System.Net.IAuthenticationModule

The IAuthenticationModule that will conduct the authentication, if authentication is required.

Return Value

Type: System.Boolean

true if the credentials are sent with the request; otherwise, false.

After an ICredentialPolicy policy has been specified by setting the AuthenticationManager.CredentialPolicy property, the IAuthenticationModule that handles authentication for a WebRequest invokes the ShouldSendCredential method before performing the authentication. If this method returns false, authentication is not performed.

When the original request has been redirected or proxy authentication is required, the resource identified by challengeUri can be different from the requested resource that is specified in WebRequest.RequestUri. In the case of redirection, challengeUri contains the actual destination Uri. If proxy authentication is required, challengeUri contains the address of the proxy server that requires client authentication.

.NET Framework
Available since 2.0
Return to top