Scope Class

.NET Framework (current version)
 

Represents the configuration for the token issuance request.

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

System.Object
  System.IdentityModel.Scope

public class Scope

NameDescription
System_CAPS_pubmethodScope()

Initializes a new instance of the Scope class.

System_CAPS_pubmethodScope(String)

Initializes a new instance of the Scope class with the specified appliesTo address.

System_CAPS_pubmethodScope(String, EncryptingCredentials)

Initializes a new instance of the Scope class with the specified appliesTo address and encrypting credentials.

System_CAPS_pubmethodScope(String, SigningCredentials)

Initializes a new instance of the Scope class with the specified appliesTo address and signing credentials.

System_CAPS_pubmethodScope(String, SigningCredentials, EncryptingCredentials)

Initializes a new instance of the Scope class with the specified appliesTo address, signing credentials, and encrypting credentials.

NameDescription
System_CAPS_pubpropertyAppliesToAddress

Gets or sets the appliesTo address of the relying party.

System_CAPS_pubpropertyEncryptingCredentials

Gets or sets the encrypting credentials for the relying party.

System_CAPS_pubpropertyProperties

Gets the properties bag to extend the object.

System_CAPS_pubpropertyReplyToAddress

Gets or sets the replyTo address of the relying party.

System_CAPS_pubpropertySigningCredentials

Gets or sets the signing credentials for the relying party.

System_CAPS_pubpropertySymmetricKeyEncryptionRequired

Gets or sets a value that indicates whether issued symmetric keys must be encrypted.

System_CAPS_pubpropertyTokenEncryptionRequired

Gets or sets a value that indicates whether issued security tokens must be encrypted.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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 M:System.IdentityModel.SecurityTokenService.Issue(System.IdentityModel.Claims.ClaimsPrincipal,System.IdentityModel.Protocols.WSTrust.RequestSecurityToken) method and this method invokes the M:System.IdentityModel.SecurityTokenService.GetScope(System.IdentityModel.Claims.ClaimsPrincipal,System.IdentityModel.Protocols.WSTrust.RequestSecurityToken) method to get the configuration for the RST. You must implement a M:System.IdentityModel.SecurityTokenService.GetScope(System.IdentityModel.Claims.ClaimsPrincipal,System.IdentityModel.Protocols.WSTrust.RequestSecurityToken) method in your custom STS and return a Scope object appropriate for the RP and your STS implementation.

.NET Framework
Available since 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.

Return to top
Show: