Raritan PX2/PX3 JSON-RPC API
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
UserManager.idl
1 #include <User.idl>
2 #include <UserEvent.idl>
3 
7 module usermgmt {
8 
10  structure Account {
11  string name;
13  };
14 
15  /* event definitions */
19  valueobject AccountEvent extends event.UserEvent {
20  string username;
21  };
22 
27  valueobject AccountAdded extends AccountEvent {};
28 
33  valueobject AccountRemoved extends AccountEvent {};
34 
39  valueobject PasswordChanged extends AccountEvent {};
40 
47  valueobject AccountChanged extends AccountEvent {
48  usermgmt.UserInfo oldSettings;
49  usermgmt.UserInfo newSettings;
50  };
51 
52 
54  interface UserManager_1_0_2 {
55 
56  constant int ERR_USER_DOESNT_EXIST = 1;
57  constant int ERR_USER_NOT_DELETABLE = 2;
58 
59  constant int ERR_USER_ALREADY_EXISTS = 1;
60  constant int ERR_MAX_USERS_REACHED = 2;
61  constant int ERR_PASSWORD_TOO_SHORT_FOR_SNMP = 3;
62  constant int ERR_INVALID_VALUE = 4;
63  constant int ERR_PASSWORD_EMPTY = 5;
64  constant int ERR_PASSWORD_TOO_SHORT = 6;
65  constant int ERR_PASSWORD_TOO_LONG = 7;
66  constant int ERR_PASSWORD_CTRL_CHARS = 8;
67  constant int ERR_PASSWORD_NEED_LOWER = 9;
68  constant int ERR_PASSWORD_NEED_UPPER = 10;
69  constant int ERR_PASSWORD_NEED_NUMERIC = 11;
70  constant int ERR_PASSWORD_NEED_SPECIAL = 12;
71 
77  vector<string> getAccountNames();
78 
106  int createAccount(in string username, in string password);
107 
117  int deleteAccount(in string username);
118 
124  vector<Account> getAllAccounts();
125 
154  int createAccountFull(in string username, in string password,
155  in UserInfo info);
156 
164  vector<Account> getAccountsByRole(in string roleName);
165 
171  Preferences getDefaultPreferences();
172 
180  int setDefaultPreferences(in Preferences prefs);
181  };
182 
183 }
UserInfo info
User information
Definition: UserManager.idl:12
valueobject AccountEvent
Base type of all account event.
Definition: UserManager.idl:20
User manager interface
Definition: UserManager.idl:54
User information
Definition: User.idl:58
User preferences
Definition: User.idl:51
valueobject PasswordChanged
This event is emitted after the password for an account was changed.
Definition: UserManager.idl:39
Account information
Definition: UserManager.idl:10
valueobject AccountRemoved
This event is emitted after the account with the provided username has been removed.
Definition: UserManager.idl:33
string name
Account name
Definition: UserManager.idl:11