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 Rational® ClearQuest® 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
- GetActive
- Indicates whether or not the user's account is active.
- GetAppBuilder
- Indicates whether or not the user has AppBuilder privileges.
- GetEMail
- Returns the user's e-mail address.
- GetFullName (See FullName)
- Returns the user's full name.
- GetGroups
- Returns a collection of groups to which the user belongs.
- GetMiscInfo
- Returns the user's miscellaneous information.
- GetName
- Returns the user's login name.
- GetPassword
- Returns the user's password.
- GetPhone
- Returns the user's phone number.
- GetSubscribedDatabases
- Returns the collection of databases to which the user is subscribed.
- GetSuperUser
- Indicates whether or not the user has SuperUser privileges.
- GetUserMaintainer
- Indicates whether or not the user has user administration privileges.
- SetActive
- Specifies whether or not the user's account is active.
- SetAppBuilder
- Specifies whether or not the user has AppBuilder privileges.
- SetEMail
- Sets the user's e-mail address.
- SetFullName. (See FullName)
- Sets the user's full name.
- SetMiscInfo
- Sets the user's miscellaneous information.
- SetPassword
- Sets the user's password.
- SetPhone
- Sets the user's phone number.
- SetSuperUser
- Specifies whether or not the user has SuperUser privileges.
- SetUserMaintainer
- Specifies whether or not the user has user administration privileges.