This documentation is archived and is not being maintained.

X509ClientCertificateAuthentication.MapClientCertificateToWindowsAccount Property

Gets or sets a value that indicates whether the certificate is mapped to Windows accounts.

Namespace: System.ServiceModel.Security
Assembly: System.ServiceModel (in system.servicemodel.dll)

public bool MapClientCertificateToWindowsAccount { get; set; }
/** @property */
public boolean get_MapClientCertificateToWindowsAccount ()

/** @property */
public void set_MapClientCertificateToWindowsAccount (boolean value)

public function get MapClientCertificateToWindowsAccount () : boolean

public function set MapClientCertificateToWindowsAccount (value : boolean)

Not applicable.

Property Value

true if the certificate is mapped to Windows accounts; otherwise, false. The default is false.

Exception typeCondition

InvalidOperationException

set when credential is read-only.

When using the certificate client credential type on bindings, the certificate is not mapped to Windows accounts. You can override this behavior using this property. When this property is set to true, it causes the identity from the client certificate to be mapped to a Windows account.

The following code illustrates setting this property.

// Create a service host.
Uri httpUri = new Uri("http://localhost/Calculator");
ServiceHost sh = new ServiceHost(typeof(Calculator), httpUri);

// Create a binding that uses Windows security.
WSHttpBinding b = new WSHttpBinding(SecurityMode.Message);
b.Security.Message.ClientCredentialType = MessageCredentialType.Windows;

// Get a reference to the authentication object.
X509ClientCertificateAuthentication myAuthProperties =
    sh.Credentials.ClientCertificate.Authentication;
// Configure IncludeWindowsGroups.
myAuthProperties.IncludeWindowsGroups = true;

The property can also be set in a configuration file.

<serviceCredentials>
  <clientCertificate>
     <authentication mapClientCertificateToWindowsAccount='true'/>
  </clientCertificate>
</serviceCredentials>

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0
Show: