Was this page helpful?
Your feedback about this content is important. Let us know what you think.
Additional feedback?
1500 characters remaining
Export (0) Print
Expand All

AuthenticationManager.PreAuthenticate Method

Preauthenticates a request.

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

public static Authorization PreAuthenticate(
	WebRequest request,
	ICredentials credentials
)

Parameters

request
Type: System.Net.WebRequest

A WebRequest to an Internet resource.

credentials
Type: System.Net.ICredentials

The ICredentials associated with the request.

Return Value

Type: System.Net.Authorization
An instance of the Authorization class if the request can be preauthenticated; otherwise, null. If credentials is null, this method returns null.

ExceptionCondition
ArgumentNullException

request is null.

If the authentication module can preauthenticate the request, the PreAuthenticate method returns an Authentication instance and sends the authorization information to the server preemptively instead of waiting for the resource to issue a challenge. This behavior is outlined in section 3.3 of RFC 2617 (HTTP Authentication: Basic and Digest Access Authentication). Authentication modules that support preauthentication allow clients to improve server efficiency by avoiding extra round trips caused by authentication challenges.

Authorization modules that can preauthenticate requests set the IAuthenticationModule.CanPreAuthenticate property to true.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1
Show:
© 2015 Microsoft