WebService.User Property

Gets the ASP.NET server User object. Can be used to authenticate whether a user is authorized to execute the request.

Namespace: System.Web.Services
Assembly: System.Web.Services (in system.web.services.dll)

public IPrincipal User { get; }
/** @property */
public IPrincipal get_User ()

public function get User () : IPrincipal

Not applicable.

Property Value

A IPrincipal representing the ASP.NET server User object.

Both Internet Information Services (IIS) and the .NET Framework need to be configured for authentication in order for the User property to be meaningful. Authentication is the process of accepting credentials from a user and validating those credentials against some authority. If the credentials are valid, you have an authenticated identity. Authentication in the .NET Framework is configured by placing entries in the web.config file.

The following example demonstrates the entries you place in the web.config file to enable Windows authentication.

 <security>
  <authentication mode="Windows"> <!-- Mode Options are Windows, Cookie, Passport and None or Empty String -->
  </authentication>
  </security>

For more information on setting up security for an XML Web service see Securing XML Web Services Created Using ASP.NET.

The example below looks up the authenticated user name and returns that name.

<%@ WebService Language="C#" Class="Util" %>
 
 using System.Web.Services;
 
 public class Util: WebService {
      [ WebMethod(Description="Obtains the User Name",EnableSession=false) ]
      public string GetUserName() {
         return User.Identity.Name;
      }
 }
    

Windows 98, Windows Server 2000 SP4, Windows Millennium Edition, 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, 2.0, 1.1, 1.0
Show: