Table of Contents

Class SecurityLogin

Namespace
ArcanaDevelopment.adTempus.Client
Assembly
ArcanaDevelopment.adTempus.Client.dll
public sealed class SecurityLogin : SecurityEntity
Inheritance
object
SecurityLogin

Properties

CID

The Class ID for the object

[IgnoreDataMember]
public override ClassID CID { get; }

Property Value

ClassID

Remarks

Obsolete. Use ClassID instead.

ClassKeyName

The key name for the class.

public override string ClassKeyName { get; }

Property Value

string

Remarks

This name the name used by adTempus to identify the class and is intended for programmatic use only. Use the ClassName for a user-friendly name.

Enabled

Indicates whether this login is enabled.

public bool Enabled { get; set; }

Property Value

bool

Remarks

If Enabled is False, the user will not be able to log in to adTempus.

ExtendedDescription

public override string ExtendedDescription { get; }

Property Value

string

IsDependent

[IgnoreDataMember]
public override bool IsDependent { get; }

Property Value

bool

LoginType

Specifies the type of login.

public LoginType LoginType { get; set; }

Property Value

LoginType

NotificationRecipients

The NotificationRecipients representing this user.

public NotificationIndividualCollection NotificationRecipients { get; }

Property Value

NotificationIndividualCollection

PasswordSet

public bool PasswordSet { get; }

Property Value

bool

WindowsSid

The SID of the Windows identity that this login represents.

public string WindowsSid { get; set; }

Property Value

string

Remarks

This value is required if the LoginType is LoginType.WindowsUser or LoginType.WindowsGroup.

Methods

GetObjectDescription()

Gets a description of the object's key settings.

protected override string GetObjectDescription()

Returns

string

Remarks

This method is called by GetDescription() to get a user-friendly description of the object (such as its key settings) for display to the user. The description should contain enough information to distinguish this object from others of the same class.

See Also

SetPassword(string)

Sets the password for an adTempus login.

public void SetPassword(string newPassword)

Parameters

NameTypeDescription
newPassword string

Remarks

A password is only specified if LoginType is LoginType.adTempusUser.

SetTypeFromNameUse(SIDNameUse)

Sets the LoginType based on a SIDNameUseValue

public bool SetTypeFromNameUse(SIDNameUse source)

Parameters

NameTypeDescription
source SIDNameUse

Returns

bool

True if the value was set, False if the SIDNameUse cannot be mapped to a LoginType

Remarks

This method is used to set the LoginType when creating a new login, after resolving a windows account name to a SID.

WriteToConfigurationReport(IADTObjectConfigurationReportWriter)

public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)

Parameters

NameTypeDescription
reportBuilder IADTObjectConfigurationReportWriter

Inherited Members