X509CertificateRecipientClientCredential.ScopedCertificates Property

Definition

Namespace:

System.ServiceModel.Security

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v6.2.0

Source:

X509CertificateRecipientClientCredential.cs

Gets a scoped certificate to use to represent the service that the client is communicating with.

public:
 property System::Collections::Generic::Dictionary<Uri ^, System::Security::Cryptography::X509Certificates::X509Certificate2 ^> ^ ScopedCertificates { System::Collections::Generic::Dictionary<Uri ^, System::Security::Cryptography::X509Certificates::X509Certificate2 ^> ^ get(); };

public System.Collections.Generic.Dictionary<Uri,System.Security.Cryptography.X509Certificates.X509Certificate2> ScopedCertificates { get; }

member this.ScopedCertificates : System.Collections.Generic.Dictionary<Uri, System.Security.Cryptography.X509Certificates.X509Certificate2>

Public ReadOnly Property ScopedCertificates As Dictionary(Of Uri, X509Certificate2)

Property Value

Dictionary<Uri,X509Certificate2>

A scoped certificate to use to represent the service that the client is communicating with.

Exceptions

InvalidOperationException

Attempted to set when the credential is read-only.

Examples

This code shows how to set this property.

X509CertificateRecipientClientCredential rcc =
    client.ClientCredentials.ServiceCertificate;

X509Certificate2 cert = new X509Certificate2();
rcc.ScopedCertificates.Add(new Uri("http://fabrikam.com/sts"), cert);

Remarks

This property enables the client to configure the service certificate to use based on the URL of the service it communicates with. This is especially useful in issued token scenarios where a client can be communicating to multiple services (the end service as well as intermediary security token services). For bindings that use certificate-based message security, this certificate is used to encrypt messages to the service, and is expected to be used by the service for signing replies to the client.

If a binding requires a certificate for the service and no specific certificate for the service URL is found in the ScopedCertificates, the default certificate is used.

See also

• DefaultCertificate