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.1.0.1000)

Syntax

public abstract class FederatedAuthenticationProtocol : ComponentBase

Public MustInherit Class FederatedAuthenticationProtocol
	Inherits ComponentBase

public ref class FederatedAuthenticationProtocol abstract : public ComponentBase

[<AbstractClassAttribute>]
type FederatedAuthenticationProtocol =  
    class
        inherit ComponentBase
    end

The FederatedAuthenticationProtocol type exposes the following members.

Constructors

	Name	Description
	FederatedAuthenticationProtocol	Initializes a new instance of the FederatedAuthenticationProtocol class

Properties

	Name	Description
	AccountNamePrefix	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.
	ComponentDescription	Gets the standard component description. (Overrides ComponentBaseComponentDescription.)
	ComponentId	Gets the component ID. (Inherited from ComponentBase.)
	ComponentName	Gets the standard component name. (Overrides ComponentBaseComponentName.)
	EssentialClaimTypes	Gets a collection containing the claim types for claims that should be retained in any cookie data.
	Id	Gets the unique identifier of the protocol (e.g. "SAML2", "WS-Federation").
	IsEnabled	Gets a value indicating whether the component is enabled. (Inherited from ComponentBase.)
	PackageId	Gets the ID of the extension package to which the component belongs. (Inherited from ComponentBase.)
	SupportsLogout	Gets a value indicating whether the protocol supports federated logout.

Methods

	Name	Description
	ConfigureApp	Configures the authentication mechanism for the specified provider.
	ConfigureServices	Configures the authentication mechanism for the specified provider.
	GenerateMetadata	Generates service provider (relying party) federation metadata for the specified provider.
	GetClaimType	Gets the claim type corresponding to the specified FederatedAuthenticationClaimKind, for the specified provider.
	GetCookieAuthenticationScheme	Gets the cookie authentication scheme for the specified provider.
	HandleError	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.
	Localize	Localizes the specified string using the engine localization service. (Inherited from ComponentBase.)
	SetProviderIdClaim	Sets the value of the authentication provider in the claims identity (if not already present). See remarks.