GenericXmlSecurityToken Class

Represents a security token that is based upon XML.


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

public class GenericXmlSecurityToken : SecurityToken

The GenericXmlSecurityToken type exposes the following members.

Public methodGenericXmlSecurityTokenInitializes a new instance of the GenericXmlSecurityToken class.

Public propertyAuthorizationPoliciesGets the collection of authorization policies for this security token.
Public propertyExternalTokenReferenceGets a security key identifier clause that references this security token when this security token is not included in the SOAP message in which it is referenced.
Public propertyIdGets a unique identifier of the security token. (Overrides SecurityToken.Id.)
Public propertyInternalTokenReferenceGets a security key identifier clause that references this security token when this security token is included in the SOAP message in which it is referenced.
Public propertyProofTokenGets the proof token for the security token.
Public propertySecurityKeysGets the cryptographic keys associated with the proof token. (Overrides SecurityToken.SecurityKeys.)
Public propertyTokenXmlGets the XML that is associated with the security token.
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 that indicates whether this security token is capable of creating the specified key identifier clause. (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 the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodMatchesKeyIdentifierClauseReturns a value that indicates 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 the current object. (Overrides Object.ToString().)

Use the GenericXmlSecurityToken class when you receive a token over the wire that is not defined in a specification or there is no way for you to determine the type of the security token. For example, in a federation scenario when you send a Request Security Token (RST) to a Security Token Service (STS) you do not always know the type of the security token returned by the STS. In such cases, you can use a GenericXmlSecurityToken to store the security token as XML along with its internal and external references.

Use the GenericXmlSecurityToken class to define claims using XML when one of the built-in security tokens does not suffice. Other security tokens can define their claims using XML, however the GenericXmlSecurityToken security token generically allows a security token to have an application-defined set of XML.

.NET Framework

Supported in: 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, 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.

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
© 2014 Microsoft