LogOnParameters Class

Specifies authentication parameters for creating a logon token or logon session.
Inheritance Hierarchy
SystemObject
  Dundas.BI.AccountServicesLogOnParameters

Namespace:  Dundas.BI.AccountServices
Assembly:  Dundas.BI.Core (in Dundas.BI.Core.dll) Version: 2.0.0.0 (24.4.0.1000)
Syntax
Copy
public class LogOnParameters

The LogOnParameters type exposes the following members.

Constructors
  NameDescription
Public methodLogOnParameters
Initializes a new instance of the LogOnParameters class
Top
Properties
  NameDescription
Public propertyAccountName
Gets or sets the account name.
Public propertyAccountProperties
Gets or sets the properties of the account which will be created or updated during the logon operation.
Public propertyCredentials
Gets or sets a collection of credentials.
Public propertyCustomAttributes
Gets or sets a collection containing custom attribute values which will be added to the logon session.
Public propertyDeleteOtherSessions
Gets or sets a value indicating whether other sessions should be deleted if required for the logon to succeed.
Public propertyEffectiveAccountName
Gets or sets a LogOnCredential corresponding to AccountName in the EffectiveCredentials collection.
Public propertyEffectiveCredentials
Gets or sets the credentials for the effective account to be logged on. See remarks.
Public propertyEnforceSessionRestrictions
Gets or sets a value indicating whether certain session restrictions are validated during the logon sequence.
Public propertyExplicitCulture
Gets or sets the culture to associate with the logon session.
Public propertyExplicitTimeZone
Gets or sets the time zone to associate with the logon session.
Public propertyGenerateDataDiscoveryTrustedAccessToken
Gets or sets a value indicating whether the logon result should include a trusted access token for the Data Discovery module.
Public propertyIsInteractiveLogOn
Gets or sets a value indicating whether the logon is coming from an interactive logon page.
Public propertyLogOnToken
Gets or sets the logon token.
Public propertyPassword
Gets or sets the password to use when AccountName is specified.
Public propertyTenantId
Gets or sets the ID of the tenant to use for the logon session.
Public propertyUseWindowsIdentity
Gets or sets a value indicating whether the current Windows identity should be used to authenticate.
Top
Remarks
The authentication operation (i.e. "logon" or "get logon token") will use the properties from this class according to the following rules:
  1. If Credentials is non-null, it will be the only property considered for authentication.
  2. Otherwise, if LogOnToken is non-null, it will be the only property considered for authentication.
  3. Otherwise, if UseWindowsIdentity is , only the windows identity associated with the caller context will considered for authentication.
  4. Otherwise, if AccountName is non-null, it will be used along with Password to authenticate.
  5. Otherwise, the authentication operation will throw InvalidOperationException, because there is not enough information to authenticate.
See Also