This documentation is archived and is not being maintained.

SamlSecurityToken Class

Represents a security token that is based upon a SAML assertion.


Namespace:  System.IdentityModel.Tokens
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public class SamlSecurityToken : SecurityToken

The SamlSecurityToken type exposes the following members.

Protected methodSamlSecurityToken()Initializes a new instance of the SamlSecurityToken class.
Public methodSamlSecurityToken(SamlAssertion)Initializes a new instance of the SamlSecurityToken class using the specified SAML assertion.

Public propertyAssertionGets the SAML assertion for this security token.
Public propertyIdGets a unique identifier of the security token. (Overrides SecurityToken.Id.)
Public propertySecurityKeysGets the cryptographic keys associated with the security token. (Overrides SecurityToken.SecurityKeys.)
Public propertyValidFromGets the first instant in time at which this security token is valid. (Overrides SecurityToken.ValidFrom.)
Public propertyValidToGets the last instant in time at which this security token is valid. (Overrides SecurityToken.ValidTo.)

Public methodCanCreateKeyIdentifierClause<T>Gets a value indicating whether this security token is capable of creating the specified key identifier. (Overrides SecurityToken.CanCreateKeyIdentifierClause<T>().)
Public methodCreateKeyIdentifierClause<T>Creates the specified key identifier clause. (Overrides SecurityToken.CreateKeyIdentifierClause<T>().)
Public methodEquals(Object)Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as a hash function for a particular type. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodInitializeInitializes the properties of the SamlSecurityToken class using the specified SAML assertion.
Public methodMatchesKeyIdentifierClauseReturns a value indicating whether the key identifier for this instance is equal to the specified key identifier. (Overrides SecurityToken.MatchesKeyIdentifierClause(SecurityKeyIdentifierClause).)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodResolveKeyIdentifierClauseGets the key for the specified key identifier clause. (Inherited from SecurityToken.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)

The claims for SamlSecurityToken security tokens are expressed as part of a SamlAssertion. A SamlAssertion has an extensible set of claims known as SAML statements that are represented by the Statements property. The SAML authority that issued the SAML assertion is specified in the Issuer property.

.NET Framework

Supported in: 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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

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