HttpWebRequest.ClientCertificates Property

Definition

Namespace:

System.Net

Assembly:

System.Net.Requests.dll

Source:

HttpWebRequest.cs

Gets or sets the collection of security certificates that are associated with this request.

public:
 property System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ ClientCertificates { System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ get(); void set(System::Security::Cryptography::X509Certificates::X509CertificateCollection ^ value); };

public System.Security.Cryptography.X509Certificates.X509CertificateCollection ClientCertificates { get; set; }

member this.ClientCertificates : System.Security.Cryptography.X509Certificates.X509CertificateCollection with get, set

Public Property ClientCertificates As X509CertificateCollection

Property Value

X509CertificateCollection

The X509CertificateCollection that contains the security certificates associated with this request.

Exceptions

ArgumentNullException

The value specified for a set operation is null.

Remarks

Caution

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

An application can add a certificate to a collection, but might not have access rights to it. To use a certificate contained in the collection, the application must have the same access rights as the entity that issued the certificate.

Note

The Framework caches SSL sessions as they are created and attempts to reuse a cached session for a new request, if possible. When attempting to reuse an SSL session, the Framework uses the first element of ClientCertificates (if there is one), or tries to reuse an anonymous sessions if ClientCertificates is empty.

Note

For performance reasons, you shouldn't add a client certificate to a HttpWebRequest unless you know the server will ask for it.

For a code example illustrating how to enumerate the certificates in the client certificate store, see the X509Certificate2Collection class.