SecurityTokenService.GetDisplayToken Method

  • Article

[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 DisplayToken to be included in the response (RSTR).

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

Usage

'Usage
Dim requestedDisplayTokenLanguage As String
Dim subject As IClaimsIdentity
Dim returnValue As DisplayToken

returnValue = Me.GetDisplayToken(requestedDisplayTokenLanguage, subject)

Syntax

'Declaration
Protected Overridable Function GetDisplayToken ( _
    requestedDisplayTokenLanguage As String, _
    subject As IClaimsIdentity _
) As DisplayToken

protected virtual DisplayToken GetDisplayToken (
    string requestedDisplayTokenLanguage,
    IClaimsIdentity subject
)

protected:
virtual DisplayToken^ GetDisplayToken (
    String^ requestedDisplayTokenLanguage, 
    IClaimsIdentity^ subject
)

protected DisplayToken GetDisplayToken (
    String requestedDisplayTokenLanguage, 
    IClaimsIdentity subject
)

protected function GetDisplayToken (
    requestedDisplayTokenLanguage : String, 
    subject : IClaimsIdentity
) : DisplayToken

Parameters

  • requestedDisplayTokenLanguage
    The requested display token language. This is an optional parameter and may be null.
  • subject
    An IClaimsIdentity that represents the collection of claims that will be placed in the issued security token.

Return Value

The DisplayToken to be included in the response. The default implementation returns null.

Remarks

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.

Including a display token in the response might expose information about the user, so the default implementation does not generate a token. Override this method to generate a display token.

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)

See Also

Reference

SecurityTokenService Class
SecurityTokenService Members
Microsoft.IdentityModel.SecurityTokenService Namespace

Other Resources

Claims Issuance Pipeline

Copyright © 2008 by Microsoft Corporation. All rights reserved.