Edit

Share via

WebRequest.Credentials Property

  • Reference

Definition

Namespace:
System.Net
Assembly:
System.Net.Requests.dll
Assembly:
System.dll
Assembly:
netstandard.dll
Source:
WebRequest.cs
Source:
WebRequest.cs
Source:
WebRequest.cs

When overridden in a descendant class, gets or sets the network credentials used for authenticating the request with the Internet resource.

public:
 virtual property System::Net::ICredentials ^ Credentials { System::Net::ICredentials ^ get(); void set(System::Net::ICredentials ^ value); };
public virtual System.Net.ICredentials Credentials { get; set; }
public virtual System.Net.ICredentials? Credentials { get; set; }
member this.Credentials : System.Net.ICredentials with get, set
Public Overridable Property Credentials As ICredentials

Property Value

ICredentials

An ICredentials containing the authentication credentials associated with the request. The default is null.

Exceptions

NotImplementedException

Any attempt is made to get or set the property, when the property is not overridden in a descendant class.

Examples

The following example sets the Credentials property using the default credentials of the current user. When the request is made, credentials stored in this property are used to validate the client. This is identical to setting the UseDefaultCredentials property to true.

// Create a request for the URL.   
WebRequest^ request = WebRequest::Create( "http://www.contoso.com/default.html" );

// If required by the server, set the credentials.
request->Credentials = CredentialCache::DefaultCredentials;

// Get the response.
HttpWebResponse^ response = dynamic_cast<HttpWebResponse^>(request->GetResponse());

// Create a request for the URL. 		
WebRequest request = WebRequest.Create ("http://www.contoso.com/default.html");
// If required by the server, set the credentials.
request.Credentials = CredentialCache.DefaultCredentials;
// Get the response.
HttpWebResponse response = (HttpWebResponse)request.GetResponse ();

' Create a request for the URL. 		
Dim request As WebRequest = WebRequest.Create("http://www.contoso.com/default.html")
' If required by the server, set the credentials.
request.Credentials = CredentialCache.DefaultCredentials
' Get the response.
Dim response As HttpWebResponse = CType(request.GetResponse(), HttpWebResponse)

Remarks

Caution

WebRequest, HttpWebRequest, ServicePoint, and WebClient are obsolete, and you shouldn't use them for new development. Use HttpClient instead.

The Credentials property contains the authentication credentials required to access the Internet resource.

Note

The WebRequest class is an abstract class. The actual behavior of WebRequest instances at run time is determined by the descendant class returned by the WebRequest.Create method. For more information about default values and exceptions, see the documentation for the descendant classes, such as HttpWebRequest and FileWebRequest.

Applies to

See also