SingleSignOnIdentity Class

Article
10/10/2016

Used by the ASP.Net web application to get direct claim information about the authenticated client. The web application can also control the occurrences of redirects to the logon server.

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

Inheritance Hierarchy

System.Object
System.Web.Security.SingleSignOn.SingleSignOnIdentity

Syntax

[SerializableAttribute]
public sealed class SingleSignOnIdentity : IIdentity

[SerializableAttribute]
public ref class SingleSignOnIdentity sealed : IIdentity

[<Sealed>]
[<SerializableAttribute>]
type SingleSignOnIdentity = 
    class
        interface IIdentity
    end

<SerializableAttribute>
Public NotInheritable Class SingleSignOnIdentity
    Implements IIdentity

Properties

	Name	Description
	AuthenticatingAuthority	Gets the authority that originally authenticated the client. This is the URI of either the account realm or the account store.
	AuthenticationMethod	Gets the authentication method used by the client to originally authenticate to its account authority.
	AuthenticationType	Gets the authentication type used to authenticate the client. This property returns WebSSO.
	IsAuthenticated	Gets information regarding whether the client has been authenticated using the WS-Federation Passive Requester Profile.
	Name	Used by the Web application to get the default name of the client authenticated using the WS-Federation Passive Requester Profile. This is the primary identity claim in the user’s security token.
	NameType	Used by the Web application to get the name type of the client authenticated using the WS-Federation Passive Requester Profile. This is the type of the user’s primary identity claim. For example: UPN, Email, Common Name.
	SecurityPropertyCollection	Gets a collection of security properties for the claims possessed by the authenticated client.
	SignInUrl	Used by the Web application to get the URL of the Logon Server for the client to sign in. This URL contains the signin protocol parameters.
	SignOutUrl	Used by the Web application to get the URL of the Logon Server for the client to sign out. This URL contains the signout protocol parameters.
	WindowsIdentity	Gets a Windows Identity property when the application has been configured as a Claims-aware application as well as a Windows NT 4.0 token based application. ASP.NET applications can access the Windows NT token of the user with the UPN from the token.

Methods

	Name	Description
	Equals(Object)	(Inherited from Object.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	SignIn(HttpContext)	Used by the Web application to redirect to the logon server for client authentication. This method is used when the authentication-required configuration parameter does not exist in the Web.config of the Web application. The most common usage for this method is when the Web designer wants clients to be able to access Web content both anonymously or as an authenticated user.
	SignOut(HttpContext)	Used by the Web application to redirect to the Logon Server for sign out. The authentication cookies for this browser session will be deleted.
	ToString()	(Inherited from Object.)
	ToWindowsIdentity(SingleSignOnIdentity)	Returns the WindowsIdentity object for the specified SingleSignOnIdentity object.

Operators

	Name	Description
	Implicit(SingleSignOnIdentity to WindowsIdentity)	Used to cast a SingleSignOnIdentity data type object to a WindowsIdentity data type object.

Remarks

The SingleSignOnIdentity object is set on the HttpContext for the Web application by the SingleSignOnAuthenticationModule. The Web forms then use the properties and methods from the SingleSignOnIdentity object to perform authentication and authorization tasks.

The SingleSignOnIdentity object is used by the ASP .NET Web application to get direct claim information about the authenticated client and to allow the application to control when redirects to the logon server occur. In addition, this object also has sign out methods.

Thread Safety

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

Share via