HttpListenerContext.User Property

Definition

Namespace:

System.Net

Assemblies:

netstandard.dll, System.Net.HttpListener.dll

Source:

HttpListenerContext.cs

Gets an object used to obtain identity, authentication information, and security roles for the client whose request is represented by this HttpListenerContext object.

C#

public System.Security.Principal.IPrincipal? User { get; }

Property Value

IPrincipal

An IPrincipal object that describes the client, or null if the HttpListener that supplied this HttpListenerContext does not require authentication.

Examples

The following code example demonstrates accessing identity and authentication information about the client, and returning it to the client in the response.

C#

public static string ClientInformation(HttpListenerContext context)
{
    System.Security.Principal.IPrincipal user = context.User;
    System.Security.Principal.IIdentity id = user.Identity;
    if (id == null)
    {
        return "Client authentication is not enabled for this Web server.";
    }

    string display;
    if (id.IsAuthenticated)
    {
        display = String.Format("{0} was authenticated using {1}", id.Name,
            id.AuthenticationType);
    }
    else
    {
       display = String.Format("{0} was not authenticated", id.Name);
    }
    return display;
}

Remarks

An HttpListener indicates that it requires authentication using the AuthenticationSchemes property or by specifying an AuthenticationSchemeSelector delegate using the AuthenticationSchemeSelectorDelegate property.

To determine the client's login name and authentication information, check the IPrincipal.Identity property in the object returned by this property.

Applies to