This topic has not yet been rated - Rate this topic

FormsAuthentication.GetAuthCookie Method (String, Boolean)

.NET Framework 4.5

Creates an authentication cookie for a given user name. This does not set the cookie as part of the outgoing response, so that an application can have more control over how the cookie is issued.

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

Syntax

C++

public static HttpCookie GetAuthCookie(
	string userName,
	bool createPersistentCookie
)

Parameters

userName: Type: System.String
The name of the authenticated user.

createPersistentCookie: Type: System.Boolean
true to create a durable cookie (one that is saved across browser sessions); otherwise, false.

Return Value

Type: System.Web.HttpCookie
An HttpCookie that contains encrypted forms-authentication ticket information. The default value for the FormsCookiePath property is used.

Remarks

The path of the cookie is determined by the FormsCookiePath property.

Version Information

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

Platforms

Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Reference

FormsAuthentication Class

GetAuthCookie Overload

System.Web.Security Namespace

Other Resources

ASP.NET Web Application Security

Did you find this helpful? Yes No

Not accurate

Not enough depth

Need more code examples

(1500 characters remaining)