|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface IPTUserManager
Used to perform administrative tasks on users
IPTUser
Method Summary | |
---|---|
IPTSession |
AcceptInvitation(java.lang.String sInvitationCode,
java.lang.String sProposedUserName,
java.lang.String sProposedPassword)
An invitation is a token that can be sent to a potential user. |
void |
AddAdminFolderShortcut(int lNewFolderIDShortcut)
AdminFolderShortcuts are favorite admin folders associated with the current user. |
IPTQueryResult |
GetLockedAccounts(java.lang.String bstrDescription,
int nSkipRows,
int nMaxRows)
Returns a QueryResult that lists the users that have been locked. |
IPTQueryResult |
QueryAdminFolderShortcuts()
AdminFolderShortcuts are favorite admin folders associated with the current user. |
void |
RemoveAdminFolderShortcut(int lFolderIDShortcut)
AdminFolderShortcuts are favorite admin folders associated with the current user. |
Method Detail |
---|
IPTQueryResult GetLockedAccounts(java.lang.String bstrDescription, int nSkipRows, int nMaxRows)
Returns a QueryResult that lists the users that have been locked. Users may be locked through IPTUser.SetLockStatus. This may happen when a security violation is suspected (for example when an employee is terminated, or when a user has attempted to login with incorrect passwords a number of times.) This also happens when the "disable" user instead of "delete" user option is turned on in an Authentication Source. In this case users are "agent disabled" as opposed to deleted.
The QueryResult contains these properties: PT_PROPID_OBJECTID, PT_PROPID_NAME, PT_PROPID_USER_LOGINNAME, PT_PROPID_DESCRIPTION, PT_PROPID_FOLDERID, PT_PROPID_CREATED, PT_PROPID_USERLOCKEDACCOUNTS_LOCKCANEXPIRE.
bstrDescription
- filters on locked account description, or the reason the account was lockednSkipRows
- number of rows to skip at the beginning, or 0 for nonenMaxRows
- maximum number of rows to return, or -1 for all
IPTSession AcceptInvitation(java.lang.String sInvitationCode, java.lang.String sProposedUserName, java.lang.String sProposedPassword)
sInvitationCode
- the token to be used to create the usersProposedUserName
- the name for the new usersProposedPassword
- the password for the new user
void AddAdminFolderShortcut(int lNewFolderIDShortcut)
lNewFolderIDShortcut
- the ID of the admin folder to addvoid RemoveAdminFolderShortcut(int lFolderIDShortcut)
lFolderIDShortcut
- the ID of the admin folder to removeIPTQueryResult QueryAdminFolderShortcuts()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |