Scope Class

Definition

Namespace:

System.IdentityModel

Assembly:

System.IdentityModel.dll

Represents the configuration for the token issuance request.

public ref class Scope

public class Scope

type Scope = class

Public Class Scope

Inheritance

Object

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.

Constructors

Scope()	Initializes a new instance of the Scope class.
Scope(String)	Initializes a new instance of the Scope class with the specified appliesTo address.
Scope(String, EncryptingCredentials)	Initializes a new instance of the Scope class with the specified appliesTo address and encrypting credentials.
Scope(String, SigningCredentials)	Initializes a new instance of the Scope class with the specified appliesTo address and signing credentials.
Scope(String, SigningCredentials, EncryptingCredentials)	Initializes a new instance of the Scope class with the specified appliesTo address, signing credentials, and encrypting credentials.

Properties

AppliesToAddress	Gets or sets the appliesTo address of the relying party.
EncryptingCredentials	Gets or sets the encrypting credentials for the relying party.
Properties	Gets the properties bag to extend the object.
ReplyToAddress	Gets or sets the replyTo address of the relying party.
SigningCredentials	Gets or sets the signing credentials for the relying party.
SymmetricKeyEncryptionRequired	Gets or sets a value that indicates whether issued symmetric keys must be encrypted.
TokenEncryptionRequired	Gets or sets a value that indicates whether issued security tokens must be encrypted.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)