Scope Class

.NET Framework 4.5

Represents the configuration for the token issuance request.

System.Object
  System.IdentityModel.Scope

Namespace:  System.IdentityModel
Assembly:  System.IdentityModel (in System.IdentityModel.dll)

public class Scope

The Scope type exposes the following members.

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

  NameDescription
Public propertyAppliesToAddressGets or sets the appliesTo address of the relying party.
Public propertyEncryptingCredentialsGets or sets the encrypting credentials for the relying party.
Public propertyPropertiesGets the properties bag to extend the object.
Public propertyReplyToAddressGets or sets the replyTo address of the relying party.
Public propertySigningCredentialsGets or sets the signing credentials for the relying party.
Public propertySymmetricKeyEncryptionRequiredGets or sets a value that indicates whether issued symmetric keys must be encrypted.
Public propertyTokenEncryptionRequiredGets or sets a value that indicates whether issued security tokens must be encrypted.
Top

  NameDescription
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

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.

.NET Framework

Supported in: 4.6, 4.5

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft