LogOnOptions Class

The options class used for logging on.

Inheritance Hierarchy

SystemObject
Dundas.BI.WebApi.ModelsLogOnTokenOptions
Dundas.BI.WebApi.ModelsLogOnOptions

Namespace: Dundas.BI.WebApi.Models
Assembly: Dundas.BI.WebApiCore (in Dundas.BI.WebApiCore.dll) Version: 2.0.0.0 (25.3.0.1000)

Syntax

C++

Copy

[DataContractAttribute]
public class LogOnOptions : LogOnTokenOptions

<DataContractAttribute>
Public Class LogOnOptions
	Inherits LogOnTokenOptions

[DataContractAttribute]
public ref class LogOnOptions : public LogOnTokenOptions

[<DataContractAttribute>]
type LogOnOptions =  
    class
        inherit LogOnTokenOptions
    end

The LogOnOptions type exposes the following members.

Constructors

	Name	Description
	LogOnOptions	Initializes a new instance of the LogOnOptions class

Top

Properties

	Name	Description
	AccountName	Gets or sets the account name. (Inherited from LogOnTokenOptions.)
	AccountProperties	Gets or sets the properties of the account which will be created or updated during the logon operation.
	Credentials	Gets or sets a collection of credentials. (Inherited from LogOnTokenOptions.)
	Culture	Gets the culture to associate with the log-on.
	CultureName	Gets or sets the name of the culture to associate with the log on.
	CustomAttributes	Gets or sets a collection containing custom attribute values which will be added to the logon session.
	DeleteOtherSessions	Gets or sets a value indicating whether other sessions should be deleted if required in order to make the logon succeed.
	EffectiveAccountName	Gets or sets a LogOnCredential corresponding to AccountName in the EffectiveCredentials collection. (Inherited from LogOnTokenOptions.)
	EffectiveCredentials	Gets or sets the credentials for the effective account to be logged on. See remarks. (Inherited from LogOnTokenOptions.)
	EnforceSessionRestrictions	Gets or sets a value indicating whether certain session restrictions are validated during the logon sequence.
	GenerateDataDiscoveryTrustedAccessToken	Gets or sets a value indicating whether the logon result should include a trusted access token for the Data Discovery module.
	IsWindowsLogOn	Gets or sets a value indicating whether the current Windows identity should be used to authenticate. (Inherited from LogOnTokenOptions.)
	LogOnToken	Gets or sets the log on token.
	Password	Gets or sets the password to use when AccountName is specified. (Inherited from LogOnTokenOptions.)
	PerformDataDiscoveryLogon	Gets or sets a value indicating whether the logon operation should also authenticate the user to the Data Discovery module. (Inherited from LogOnTokenOptions.)
	TenantId	Gets or sets the ID of the tenant to use for the logon session. (Inherited from LogOnTokenOptions.)
	TimeZone	Gets the time zone to associate with the log on.
	TimeZoneId	Gets or sets the ID of the time zone to associate with the log on.

Top

Methods

	Name	Description
	FromDataContractMappings	The mapping between LogOnOptions and LogOnParameters.

Top

Reference

Dundas.BI.WebApi.Models Namespace

Dundas.BI.AccountServicesLogOnParameters