This documentation is archived and is not being maintained.

SecurityTokenService.GetTokenLifetime Method

Windows Identity Foundation

[Starting with the .NET Framework 4.5, Windows Identity Foundation (WIF) has been fully integrated into the .NET Framework. The version of WIF addressed by this topic, WIF 3.5, is deprecated and should only be used when developing against the .NET Framework 3.5 SP1 or the .NET Framework 4. For more information about WIF in the .NET Framework 4.5, also known as WIF 4.5, see the Windows Identity Foundation documentation in the .NET Framework 4.5 Development Guide.]

Gets the lifetime for the issued token.

Namespace: Microsoft.IdentityModel.SecurityTokenService
Assembly: Microsoft.IdentityModel (in Microsoft.IdentityModel.dll)

Usage

'Usage
Dim requestLifetime As Lifetime
Dim returnValue As Lifetime

returnValue = Me.GetTokenLifetime(requestLifetime)

Syntax

C++

protected:
virtual Lifetime^ GetTokenLifetime (
	Lifetime^ requestLifetime
)

protected Lifetime GetTokenLifetime (
	Lifetime requestLifetime
)

JScript

protected function GetTokenLifetime (
	requestLifetime : Lifetime
) : Lifetime

Parameters

requestLifetime: A Lifetime that represents the requested lifetime.

Return Value

A Lifetime that represents the granted lifetime.

Remarks

This method is normally called with the lifetime that arrived in the RST. In the default implementation, the token lifetime is calculated according to the following table.

Created (in)	Expires (in)	Created (in)	Expires (out)
null	null	DateTime.UtcNow	DateTime.UtcNow + SecurityTokenServiceConfiguration.DefaultTokenLifetime
C	null	C	C + SecurityTokenServiceConfiguration.DefaultTokenLifetime
null	E	DateTime.UtcNow	E
C	E	C	E

This method is called from the default token issuance pipeline implemented in the Issue method. For more information about the token issuance pipeline, see the Claims Issuance Pipeline topic.

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.

Platforms

Target Platforms

Windows 7, Windows Server 2008 R2, Windows Vista SP2, Windows Server 2008 SP2, Windows Server 2003 SP2 (32-bit or 64-bit)