SecurityToken.Id Property

Definition

Namespace:

System.IdentityModel.Tokens

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.0.0

Gets a unique identifier of the security token.

public:
 abstract property System::String ^ Id { System::String ^ get(); };

public abstract string Id { get; }

member this.Id : string

Public MustOverride ReadOnly Property Id As String

Property Value

String

The unique identifier of the security token.

Examples

The code examples that are used in the SecurityToken topics are taken from the Custom Token sample. This sample provides custom classes that enable processing of Simple Web Tokens (SWT). It includes an implementation of a SimpleWebToken class and a SimpleWebTokenHandler class, as well as other classes that support SWT tokens. For information about this sample and other samples available for WIF and about where to download them, see WIF Code Sample Index. The following code shows the override of the Id property.

/// <summary>
/// Defines the set of constants for the Simple Web Token.
/// </summary>
public static class SimpleWebTokenConstants
{
    public const string Audience = "Audience";
    public const string ExpiresOn = "ExpiresOn";
    public const string Id = "Id";
    public const string Issuer = "Issuer";
    public const string Signature = "HMACSHA256";
    public const string ValidFrom = "ValidFrom";
    public const string ValueTypeUri = "http://schemas.xmlsoap.org/ws/2009/11/swt-token-profile-1.0";     
}

public static DateTime SwtBaseTime = new DateTime( 1970, 1, 1, 0, 0, 0, 0 ); // per SWT psec

NameValueCollection _properties;

/// <summary>
/// Gets the Id of the token.
/// </summary>
/// <value>The Id of the token.</value>
public override string Id
{
    get 
    {
        return _properties[SimpleWebTokenConstants.Id];
    }
}

Remarks

Typically, when a security token is serialized into XML, the Id attribute for the security token is set to the value of the Id property.

Notes to Implementers

You must override the Id property.