User object methods
The following list summarizes the User object methods:
Note: For all Perl Get and Set methods
that map to Visual Basic Properties, see the Properties section of
this object.
- Method name
- Description
- GetAuthenticationMode
- Returns the current authentication mode of the User.
GetMasterReplicaName
- Perl only. Returns the name of the replica that masters the group.
GetUserPrivilege
- Perl only. Tests whether the User has a specified user privilege.
IsSubscribedToAllDatabases
- Returns Boolean True if the User is subscribed to all databases in the schema repository, False otherwise.
- SetCQAuthentication
- Sets a user account authentication mode to CQ_AUTHENTICATION, which uses traditional HCL Compass enabled user authentication.
- SetLDAPAuthentication
- Sets a user for LDAP authentication. This method sets the user account authentication mode to LDAP_AUTHENTICATION, which authenticates against an LDAP server.
SetLoginName
- Change a login name and/or password.
SetMasterReplicaByName
- Perl only. Sets the replica that masters the group record.
SetSubscribedToAllDatabases
- Subscribes the user to all user databases in the schema repository (master database).
SetUserPrivilege
- Perl only. Sets a User privilege.
SiteHasMastership
- Tests whether this object is mastered in the session database.
SubscribeDatabase
- Subscribes this user to the specified database.
UnsubscribeAllDatabases
- Unsubscribes the user from all databases.
UnsubscribeDatabase
- Unsubscribes the user from the specified database.
UpgradeInfo
- Upgrades the user profile related information to all the user databases that the user is currently subscribed to.
Additional Perl Get and Set Methods that map to Visual Basic properties:
- Method name
- Description
- Get
Active
- Indicates whether or not the user's account is active.
- Get
AppBuilder
- Indicates whether or not the user has AppBuilder privileges.
- Get
EMail
- Returns the user's e-mail address.
- GetFullName (See
FullName
) - Returns the user's full name.
- Get
Groups
- Returns a collection of groups to which the user belongs.
- Get
MiscInfo
- Returns the user's miscellaneous information.
- Get
Name
- Returns the user's login name.
- Get
Password
- Returns the user's password.
- Get
Phone
- Returns the user's phone number.
- Get
SubscribedDatabases
- Returns the collection of databases to which the user is subscribed.
- Get
SuperUser
- Indicates whether or not the user has SuperUser privileges.
- Get
UserMaintainer
- Indicates whether or not the user has user administration privileges.
- Set
Active
- Specifies whether or not the user's account is active.
- Set
AppBuilder
- Specifies whether or not the user has AppBuilder privileges.
- Set
EMail
- Sets the user's e-mail address.
- SetFullName. (See
FullName
) - Sets the user's full name.
- Set
MiscInfo
- Sets the user's miscellaneous information.
- Set
Password
- Sets the user's password.
- Set
Phone
- Sets the user's phone number.
- Set
SuperUser
- Specifies whether or not the user has SuperUser privileges.
- Set
UserMaintainer
- Specifies whether or not the user has user administration privileges.