SecurityBindingElement.EndpointSupportingTokenParameters Property

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Primitives.dll

Package:

System.ServiceModel.Primitives v8.1.0

Source:

SecurityBindingElement.cs

Gets the endpoint that supports token parameters.

public:
 property System::ServiceModel::Security::Tokens::SupportingTokenParameters ^ EndpointSupportingTokenParameters { System::ServiceModel::Security::Tokens::SupportingTokenParameters ^ get(); };

public System.ServiceModel.Security.Tokens.SupportingTokenParameters EndpointSupportingTokenParameters { get; }

member this.EndpointSupportingTokenParameters : System.ServiceModel.Security.Tokens.SupportingTokenParameters

Public ReadOnly Property EndpointSupportingTokenParameters As SupportingTokenParameters

Property Value

SupportingTokenParameters

The SupportingTokenParameters object that represents the endpoint that supports token parameters.

Remarks

Supporting tokens provide additional claims beyond those contained in the primary tokens for the binding. The collection returned by the EndpointSupportingTokenParameters contains additional token parameters (SecurityTokenParameters) for all operations defined by an endpoint. The primary token parameters are found on either the SymmetricSecurityBindingElement or the AsymmetricSecurityBindingElement (both inherit from the SecurityBindingElement class). In the case of the SymmetricSecurityBindingElement, the primary token parameters are returned by the ProtectionTokenParameters property. On the AsymmetricSecurityBindingElement element there are two parameter properties, the InitiatorTokenParameters and RecipientTokenParameters properties.

Note

The properties are called parameters because they specify only the type of the security token, not the actual values.

Supporting tokens can be scoped at the endpoint level, in which case they are included in all secured messages sent by the client to the service. The service enforces that all secured messages from the client contain the supporting token types configured by this property.

To provide supporting tokens only for an operation (not all operations on an endpoint), use the OptionalOperationSupportingTokenParameters property.