Scope Class

  • 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.]

Represents the configuration for the token issuance request.

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

Usage

'Usage
Dim instance As Scope

Syntax

'Declaration
Public Class Scope

public class Scope

public ref class Scope

public class Scope

public class Scope

Remarks

The Scope class encapsulates information about the relying party (RP) associated with a security token request (RST). This information is used by implementations of the SecurityTokenService class (STS) in the token issuance pipeline to return a response (RSTR) to a security token request (RST).

Scope objects contain information about the address of the RP, the encrypting and signing credentials to be used with the issued security token, and whether the token itself or symmetric keys issued with the token should be encrypted. By default, both the token and symmetric keys are encrypted. You can extend the Scope class to carry additional information about the request, such as token types accepted by the RP, default token lifetime, maximum token lifetime, algorithm suites used by the RP, and so on; however, the information encapsulated in this class should not vary for individual requests.

The token issuance pipeline is implemented in the Issue method and this method invokes the GetScope method to get the configuration for the RST. You must implement a GetScope method in your custom STS and return a Scope object appropriate for the RP and your STS implementation. For more information about the token issuance pipeline, see Claims Issuance Pipeline. For more information about building an STS and using Scope objects, see the topics under Claims Provider - Security Token Service.

Inheritance Hierarchy

System.Object
  Microsoft.IdentityModel.SecurityTokenService.Scope

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

Scope Members
Microsoft.IdentityModel.SecurityTokenService Namespace

Other Resources

Claims Issuance Pipeline
Claims Provider - Security Token Service

Copyright © 2008 by Microsoft Corporation. All rights reserved.