UserNamePasswordServiceCredential Class

 

Represents a class that is used to configure how the service authenticates users that use user name/password authentication and to configure the caching of logon tokens.

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

System.Object
  System.ServiceModel.Security.UserNamePasswordServiceCredential

public sealed class UserNamePasswordServiceCredential

NameDescription
System_CAPS_pubpropertyCachedLogonTokenLifetime

Gets or sets the maximum length of time that a token is cached.

System_CAPS_pubpropertyCacheLogonTokens

Gets or sets a value that indicates whether logon tokens are cached.

System_CAPS_pubpropertyCustomUserNamePasswordValidator

Gets or sets a custom user name and password validator.

System_CAPS_pubpropertyIncludeWindowsGroups

Gets or sets a value that indicates whether Windows groups are included in the security context.

System_CAPS_pubpropertyMaxCachedLogonTokens

Gets or sets the maximum number of logon tokens to cache.

System_CAPS_pubpropertyMembershipProvider

Gets or sets the membership provider.

System_CAPS_pubpropertyUserNamePasswordValidationMode

Gets or sets the method of validating the user name and password.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

If none of the bindings used by a service is configured for user name/password-based authentication, the relevant properties for this class are ignored. These properties include the CustomUserNamePasswordValidator, IncludeWindowsGroups, MembershipProvider, and UserNamePasswordValidationMode properties.

If none of the bindings used by a service is configured to use Windows authentication for user name/password, the settings related to caching of logon tokens are ignored. These settings include the CachedLogonTokenLifetime, CacheLogonTokens, and MaxCachedLogonTokens properties.

The following example prints the values of the UserNamePasswordServiceCredential properties for a service.

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

// Create a binding that uses a username/password credential.
WSHttpBinding b = new WSHttpBinding(SecurityMode.Message);
b.Security.Message.ClientCredentialType = MessageCredentialType.UserName;

// Add an endpoint.
sh.AddServiceEndpoint(typeof(ICalculator), b, "UserNamePasswordCalculator");

// Get a reference to the UserNamePasswordServiceCredential object.
UserNamePasswordServiceCredential unpCredential = 
    sh.Credentials.UserNameAuthentication;
// Print out values.
Console.WriteLine("IncludeWindowsGroup: {0}", 
    unpCredential.IncludeWindowsGroups);
Console.WriteLine("UserNamePasswordValidationMode: {0}",
    unpCredential.UserNamePasswordValidationMode);
Console.WriteLine("CachedLogonTokenLifetime.Minutes: {0}",
    unpCredential.CachedLogonTokenLifetime.Minutes );
Console.WriteLine("CacheLogonTokens: {0}",
    unpCredential.CacheLogonTokens );
Console.WriteLine("MaxCachedLogonTokens: {0}",
    unpCredential.MaxCachedLogonTokens );

Console.ReadLine();

.NET Framework
Available since 3.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: