AuthenticationProviderSettings Class Reference

AuthenticationProviderSettings class More...

Public Member Functions
	AuthenticationProviderSettings ()
	Initializes a new instance of the AuthenticationProviderSettings class. More...

Properties
StringCollection	AlternativeResponseCertificates [get, set]
	Gets or sets the alternative response certificates. More...
short	AuthenticationContextType [get, set]
	Gets or sets the Authentication contex type More...
short	BindingType [get, set]
	Gets or sets the Settings More...
bool	LogOffProvider [get, set]
	Gets or sets a value indicating whether [log off provider]. More...
string	RelyingParty [get, set]
	Gets or sets the relying party. This is usually optional, but some Providers like Azure AD, ADFS need this to be specified. For Azure AD this property should be specified with the App ID URI/Identifier, for ADFS this should be specified with the Relying Trust Party Identifier. Note: If the App ID URI/Identifier(for Azure AD) or the Relying Trust Party Identifier(for ADFS) is same as TA server URL (for example: http://server/TotalAgility/), you need not specify this property. More...
SignatureSettings	SamlRequestSignatureSettings [get, set]
	Gets or sets the settings to sign saml requests. More...
UserClaimMappings	UserClaimMappings [get, set]
	Gets or sets the User Claim Mappings More...
UserClaimRules	UserClaimRules [get, set]
	Gets or sets the User Claim Rules More...
bool	UseRelayStateOnly [get, set]
	Gets or sets a value indicating whether [use relay state only]. When set to true, TA will not include any query string parameters in the ACS URL and will rely solely on relay state functionality. The provider must support relay state functionality too. When set to false, TA will keep using the default way of using both the query string params and the relay state(whichever works). Relying on query string parameters in the ACS URL can cause issues with providers that require exact match of the ACS URL. In such cases, we should avoid query string params and use relay state only(that is if provider supports relay state). If the provider supports relay state, this should be set to true. This is the recommended way to relay data between the app and provider. More...

Description

AuthenticationProviderSettings class

Constructor & Destructor Documentation

AuthenticationProviderSettings

(

)

Initializes a new instance of the AuthenticationProviderSettings class.

Property Documentation

StringCollection AlternativeResponseCertificates

getset

Gets or sets the alternative response certificates.

The alternative response certificates.

short AuthenticationContextType

getset

Gets or sets the Authentication contex type

short BindingType

getset

Gets or sets the Settings

bool LogOffProvider

getset

Gets or sets a value indicating whether [log off provider].

true if [log off provider]; otherwise, false.

string RelyingParty

getset

Gets or sets the relying party. This is usually optional, but some Providers like Azure AD, ADFS need this to be specified. For Azure AD this property should be specified with the App ID URI/Identifier, for ADFS this should be specified with the Relying Trust Party Identifier.
Note: If the App ID URI/Identifier(for Azure AD) or the Relying Trust Party Identifier(for ADFS) is same as TA server URL (for example: http://server/TotalAgility/), you need not specify this property.

The relying party.

SignatureSettings SamlRequestSignatureSettings

getset

Gets or sets the settings to sign saml requests.

The request signature settings.

UserClaimMappings UserClaimMappings

getset

Gets or sets the User Claim Mappings

UserClaimRules UserClaimRules

getset

Gets or sets the User Claim Rules

bool UseRelayStateOnly

getset

Gets or sets a value indicating whether [use relay state only]. When set to true, TA will not include any query string parameters in the ACS URL and will rely solely on relay state functionality. The provider must support relay state functionality too. When set to false, TA will keep using the default way of using both the query string params and the relay state(whichever works). Relying on query string parameters in the ACS URL can cause issues with providers that require exact match of the ACS URL. In such cases, we should avoid query string params and use relay state only(that is if provider supports relay state). If the provider supports relay state, this should be set to true. This is the recommended way to relay data between the app and provider.

true if [use relay state only]; otherwise, false.