 GetAuthenticationSourceID | Retrieves the authentication source ID for this user. |
| GetAuthenticationUser | Retrieves the authentication name for the user. Can only be called for users that are synchronized with an external authentication source, not for users created within Plumtree that are part of the Plumtree Authentication Source. Authentication user name is used for logging in. |
| GetDefaultProfile | Retrieves the ID of the Default Profile from which this user was created. |
| GetEncryptedNumericPassword | Retrieves the encrypted numeric password. The string returned will be different every time this method is called, though the underlying password may actually be the same. |
| GetEncryptedPassword | Retrieves the encrypted password for the user. Can only be called for users that are created within Plumtree and are part of the Plumtree Authentication Source; not valid for externally authenticated users. The string returned will be different every time this method is called, though the underlying password may actually be the same. |
| GetLockedStatus | Retrieves the lock status for this user account. |
| GetLoginName | Retrieves the login name for the user, which uniquely identifies the user within Plumtree, and is used in calls to IPTSession.Connect(). |
| GetMappingAuthName | Retrieves the Mapping Auth Name for the user. The Mapping Auth Name is used with users that are synchronized from an external authentication source, and is specific to the Authentication Source Provider. It maps the user name used in ACL sync agents. |
| GetNumericUserName | Retrieves the numeric user name for this user. The numeric user name is used with numeric authentication, for example when logging in with a mobile device. This is the string expected from in calls to IPTSession.NumericConnect(). |
| GetPersonalInformation | Retrieve the user preferences for this user. Returns the propertybag that is a generic container of metadata stored with the user object. This is obsolete with the introduction of the 5.0 user profiling features and should not be used. |
| GetUniqueAuthName | Retrieves the Auth Unique Name for the user. The Auth Unique Name is used with users that are synchronized from an external authentication source, and represents the user's unique name within that authentication source, as opposed to Login Name, which uniquely identifies a user within Plumtree). For example, an LDAP provider might have a "CN=bob,OU=plumtree" string whereas an NT provider might have "PLUMTREE\Bob". |
| GetUserType | Retrieves the user type for the user, which identifies the user as either a regular user or a guest user. |
| IsGuestUser | Returns true if the user is of type PT_USER_TYPES.PT_USER_TYPE_GUEST |
| QueryDirectGroups | Overloaded. Queries for the user's group memberships, without taking into account any nested group hierarchy. This method is mainly for displaying what groups a user has been added to or included in by dynamic membership rule. This function returns both static and dynamic memberships. |
| QueryFlattenedGroups | Queries for the user's group memberships, taking into account any nested group hierarchy. This method should be used when security-related information is needed. |
| QueryUserGroups | This method is deprecated for 5.0 and later. |
| SetAuthenticationSourceID | Sets the authentication source ID for this user. Cannot modify built-in users. The ID is validated to make sure it identifies an existing auth source. This will be used by the login process to reference the correct AuthSource to validate the user's credentials. |
| SetAuthenticationUser | Sets the login name for the user. Can only be called for users that are synchronized using an external authentication source, not for users created within Plumtree that are part of the Plumtree Authentication Source. Authentication user name is used for logging in. |
| SetDefaultProfile | Sets the objectID which is the Default Profile that should be used for this user. |
| SetEncryptedNumericPassword | Sets the encrypted numeric password. This method is only available to Administrators. Normally the IPTUser.SetNumericPassword() method should be used by clients instead of this method. |
| SetEncryptedPassword |
Sets the (encrypted) password for the user. Only applies to users from the Plumtree Authentication Source, cannot be called on users that have been synchronized from an external authentication source. This method is only available to Administrators. Normally the IPTUser.SetPassword() method should be used by clients instead of this method. |
| SetLockedStatus | Sets the locked status for this user account. Cannot lock the built-in Guest user account. Also a user cannot lock their own user account. |
| SetLoginName | Sets the login name for the user, which uniquely identifies the user within Plumtree. |
| SetMappingAuthName | Sets the Mapping Auth Name for the user. The Mapping Auth Name is used with users that are synchronized from an external authentication source, and is specific to the Authentication Source Provider. It maps the user name used in ACL sync agents. |
| SetNumericPassword |
Sets the user's numeric password (PIN), which can be used in calls to IPTSession.NumericConnect(). The new password's length in characters must be less than that specified in the PT_SERVERCONTSTANTS.MAX_NUMERIC_STORESIZE. The string passed in must convert to a valid numeric string. |
| SetNumericUserName | Sets the numeric user name for this user. The numeric user name is used with numeric authentication, for example when logging in with a mobile device. |
| SetPassword |
Sets the password for the user. Only applies to users from the Plumtree Authentication Source, cannot be called on users that have been synchronized from an external authentication source. The new password's length in characters must be less than the value specified by the PT_SERVERCONSTANTS.PT_MAX_PASSWORDSIZE constant, and cannot contain newline, carriage return, or tab characters. |
| SetUniqueAuthName | Sets the Auth Unique Name for the user. The Auth Unique Name is used with users that are synchronized from an external authentication source, and represents the user's unique name within that authentication source, as opposed to Login Name, which uniquely identifies a user within Plumtree). Note that setting this is illegal for users whose passwords are stored in the portal database (ie, has a Plumtree AuthSourceID). |
| SetUserType | Sets the user type for the user, which identifies the user as either a regular user or a guest user. |
