Class CredentialProfile
- Namespace
- ArcanaDevelopment.adTempus.Client
- Assembly
- ArcanaDevelopment.adTempus.Client.dll
Stores a set of login credentials (user ID and password) for Windows or another system.
[ComVisible(true)]
[Guid("619f8180-6a62-460a-9a6d-8396ec3e5a1a")]
public sealed class CredentialProfile : ADTIndependentObject
- Inheritance
-
objectCredentialProfile
Properties
AgentProfiles
A collection of overrides, allowing the credential settings to be overridden for Remote Agents.
public RemoteAgentCredentialProfileCollection AgentProfiles { get; }
Property Value
Remarks
If a different user ID and/or password needs to be used for this job on a particular Remote Agent, add a RemoteAgentCredentialProfile to configure the settings for that Agent.
CID
The Class ID for the object
[IgnoreDataMember]
public override ClassID CID { get; }
Property Value
Remarks
Obsolete. Use ClassID instead.
CanImpersonateSystem
public bool CanImpersonateSystem { get; set; }
Property Value
- bool
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.
CredentialSelector
Additional selector or discriminator for use with non-windows credentials.
public string CredentialSelector { get; set; }
Property Value
- string
Remarks
The CredentialSelector can be used to specify context information for credentials. For example, if a profile is being used to store database connection credentials, the CredentialSelector may be set to the name of the database server so that all credentials for the server can be easily retrieved, and to prevent naming conflicts if the same user ID needs to be defined for more than one server.
CredentialType
The kind of credentials represented.
public string CredentialType { get; set; }
Property Value
- string
Remarks
A CredentialProfile can represent login credentials for many kinds of systems (Windows, a Web server, etc.). The CredentialType indicates the type of login for which these credentials are indended.
The following CredentialTypes are currently defined:
| (null or empty string) | A Windows login |
| ArcanaDevelopment.adTempus.SQLServerCredentials | A database login for the DatabaseOperationTask. The database type does not need to be SQL Server, despite the name of the CredentialType (which is retained for backward compatibility). The CredentialSelector can be used to restrict the credentials to a particular database server/database name combination. |
| ArcanaDevelopment.adTempus.WebCredentials | Credentials for a Web server used by a WebRequestTask. |
- See Also
CredentialTypeDisplay
The user-friendly type description to display when showing the profile to a user.
public string CredentialTypeDisplay { get; set; }
Property Value
- string
Description
An optional description or notes about the profile.
public string Description { get; set; }
Property Value
- string
Domain
Returns the domain portion of the UserID, if one is present.
public string Domain { get; }
Property Value
- string
The domain name for the UserID, or an empty string if the userID does not contain a domain.
Remarks
If the UserID contains a domain and user ID, Domain returns the domain only, without the user name.
- See Also
ExtendedDescription
public override string ExtendedDescription { get; }
Property Value
- string
FullyQualifiedID
Gets the fully-qualified ID, which includes the CredentialType, CredentialSelector, and UserID
public string FullyQualifiedID { get; }
Property Value
- string
IsDependent
[IgnoreDataMember]
public override bool IsDependent { get; }
Property Value
- bool
IsLocalSystem
Indicates whether this profile represents the System account on Windows.
public bool IsLocalSystem { get; }
Property Value
- bool
IssueExpirationAlerts
Determines whether adTempus should issue alerts when the profile's password is nearing expiration or has expired.
public bool IssueExpirationAlerts { get; set; }
Property Value
- bool
- See Also
LastPasswordChange
The date/time (in UTC) when the password was last changed.
[ComVisible(false)]
public DateTime? LastPasswordChange { get; set; }
Property Value
- DateTime?
PasswordExpirationDate
The expiration date (in UTC) for the current password.
[ComVisible(false)]
public DateTime? PasswordExpirationDate { get; set; }
Property Value
- DateTime?
PasswordExpirationDays
The number of days after which the password expires.
public int PasswordExpirationDays { get; set; }
Property Value
- int
Remarks
This value is stored for calculating the PasswordExpirationDate.
SupportedSecurityActions
public override Dictionary<int, string> SupportedSecurityActions { get; }
Property Value
- Dictionary<int, string>
UserID
The user ID (including Windows domain, if appropriate).
public string UserID { get; set; }
Property Value
- string
UserName
Returns the user name portion of the UserID.
public string UserName { get; }
Property Value
- string
The user name part of the UserID.
Remarks
If the UserID contains a domain and user ID, UserName returns the name only, without the domain.
- See Also
Methods
CanPerform(SecurityPermission)
Determines whether the user has the necessary permission to perform a specified action on the object
public override bool CanPerform(SecurityPermission action)
Parameters
| Name | Type | Description |
|---|---|---|
action |
SecurityPermission |
Returns
- bool
ChangePassword(string, string, DateTime?)
Changes the password for the profile.
public void ChangePassword(string oldPassword, string newPassword, DateTime? passwordExpirationDate)
Parameters
| Name | Type | Description |
|---|---|---|
oldPassword |
string | The current password for the profile. See Remarks. |
newPassword |
string | The new password. |
passwordExpirationDate |
DateTime? | The expiration date for the password, if expiration tracking is being used. |
Remarks
If the caller has Modify permission for the profile, the oldPassword does not need to be
specified. If the caller does not have Modify permission, the password can still be changed by specifying
both the oldPassword and the newPassword.
- See Also
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 to the new value.
public void SetPassword(string value)
Parameters
| Name | Type | Description |
|---|---|---|
value |
string | The new password for the profile. |
Remarks
This method sets the password to the specified value, and sets the LastPasswordChange to the current date/time.
The change takes place only once the CredentialProfile is saved; the caller must have Modify permission for the profile.
- See Also
ValidateLoginCredentials(out MessageCollection)
public bool ValidateLoginCredentials(out MessageCollection messages)
Parameters
| Name | Type | Description |
|---|---|---|
messages |
MessageCollection |
Returns
- bool
VerifyPassword(string, bool)
public bool VerifyPassword(string passwordToTest, bool addPermission)
Parameters
| Name | Type | Description |
|---|---|---|
passwordToTest |
string | |
addPermission |
bool |
Returns
- bool
WriteToConfigurationReport(IADTObjectConfigurationReportWriter)
public override void WriteToConfigurationReport(IADTObjectConfigurationReportWriter reportBuilder)
Parameters
| Name | Type | Description |
|---|---|---|
reportBuilder |
IADTObjectConfigurationReportWriter |
Inherited Members
- ADTIndependentObject.Refresh()
- ADTIndependentObject.Revert()
- ADTIndependentObject.Save()
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.Save(out MessageCollection)
- ADTIndependentObject.SaveWithAuditOrSnapshot(ChangeLogParameters, out MessageCollection)
- ADTIndependentObject.Delete()
- ADTIndependentObject.DeleteWithAuditOrSnapshot(ChangeLogParameters)
- ADTIndependentObject.GetSecurityDescriptor()
- ADTIndependentObject.ReplaceObjectReferences(string[], bool, int, IEnumerable<OID>, ADTObject, bool, ChangeLogParameters)
- ADTIndependentObject.GetObjectReferences(string[], bool, int)
- ADTObject.LastModified
- ADTObject.CreationTimestamp
- ADTObject.FromMaster
- ADTObject.OID
- ADTObject.ClassID
- ADTObject.BindingDescription
- ADTObject.ToString()
- ADTObject.ParentObject
- ADTObject.Duplicate()
- ADTObject.DataContext
- ADTObject.AccessMask
- ADTObject.Validate(MessageCollection)
- ADTObject.SupportedSecurityInheritanceOptions
- ADTObject.GetTopLevelOwner()
- ADTObject.GetConfigurationReport()
- ADTObject.GetConfigurationReport(bool)
- ADTObject.IsReadOnly
- ObjectBase.IsDirty
- ObjectBase.IsNew
- ObjectBase.IsStub
- ObjectBase.ClassName
- ObjectBase.GetDescription()
- ObjectBase.BeginEdit()
- ObjectBase.BeginEdit(UndoLevelAction)
- ObjectBase.CommitEdit(Guid)
- ObjectBase.CommitEdit()
- ObjectBase.UndoEdit()
- ObjectBase.UndoEdit(Guid)