FederatedAuthenticationProtocol Class

Base class for federated authentication protocol implementations.
Inheritance Hierarchy
SystemObject
  Dundas.BI.ExtensibilityComponentBase
    Dundas.BI.AccountServices.ExtensibilityFederatedAuthenticationProtocol

Namespace:  Dundas.BI.AccountServices.Extensibility
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.3.0.1000)
Syntax
public abstract class FederatedAuthenticationProtocol : ComponentBase

The FederatedAuthenticationProtocol type exposes the following members.

Constructors
  NameDescription
Protected methodFederatedAuthenticationProtocol
Initializes a new instance of the FederatedAuthenticationProtocol class
Top
Properties
  NameDescription
Public propertyAccountNamePrefix
Gets an optional prefix to use when determining the account name. If specified, the prefix will be prepended to whatever account name is extracted from the claims. The default value is Empty.
Public propertyComponentDescription
Gets the standard component description.
(Overrides ComponentBaseComponentDescription.)
Public propertyComponentId
Gets the component ID.
(Inherited from ComponentBase.)
Public propertyComponentName
Gets the standard component name.
(Overrides ComponentBaseComponentName.)
Public propertyEssentialClaimTypes
Gets a collection containing the claim types for claims that should be retained in any cookie data.
Public propertyId
Gets the unique identifier of the protocol (e.g. "SAML2", "WS-Federation").
Public propertyIsEnabled
Gets a value indicating whether the component is enabled.
(Inherited from ComponentBase.)
Public propertyPackageId
Gets the ID of the extension package to which the component belongs.
(Inherited from ComponentBase.)
Public propertySupportsLogout
Gets a value indicating whether the protocol supports federated logout.
Top
Methods
  NameDescription
Public methodConfigureApp
Configures the authentication mechanism for the specified provider.
Public methodConfigureServices
Configures the authentication mechanism for the specified provider.
Public methodGenerateMetadata
Generates service provider (relying party) federation metadata for the specified provider.
Public methodGetClaimType
Gets the claim type corresponding to the specified FederatedAuthenticationClaimKind, for the specified provider.
Public methodGetCookieAuthenticationScheme
Gets the cookie authentication scheme for the specified provider.
Protected methodHandleError
Instructs the application to handle an error. This typically results in a redirection to an error page which displays the error message to the user.
Protected methodLocalize
Localizes the specified string using the engine localization service.
(Inherited from ComponentBase.)
Protected methodSetProviderIdClaim
Sets the value of the authentication provider in the claims identity (if not already present). See remarks.
Top
See Also