Raritan EMX JSON-RPC API
User.idl
1 #include "Role.idl"
2 #include "SnmpV3.idl"
3 
7 module usermgmt {
8 
10  structure SnmpV3Settings {
11  boolean enabled;
17  string authPassphrase;
22  string privPassphrase;
23  };
24 
26  structure AuxInfo {
27  string fullname;
28  string telephone;
29  string eMail;
30  };
31 
33  enumeration TemperatureEnum {
36  };
37 
39  enumeration LengthEnum {
42  };
43 
45  enumeration PressureEnum {
47  PSI
48  };
49 
51  structure Preferences {
55  };
56 
58  structure UserInfo {
59  boolean enabled;
60  boolean locked;
61  boolean blocked;
65  string sshPublicKey;
67  vector<int> roleIds;
68  };
69 
75  structure UserCapabilities {
76  boolean canSetPassword;
78  };
79 
81  interface User_1_0_2 {
82 
83  constant int ERR_PASSWORD_UNCHANGED = 1;
84  constant int ERR_PASSWORD_EMPTY = 2;
85  constant int ERR_PASSWORD_TOO_SHORT = 3;
86  constant int ERR_PASSWORD_TOO_LONG = 4;
87  constant int ERR_PASSWORD_CTRL_CHARS = 5;
88  constant int ERR_PASSWORD_NEED_LOWER = 6;
89  constant int ERR_PASSWORD_NEED_UPPER = 7;
90  constant int ERR_PASSWORD_NEED_NUMERIC = 8;
91  constant int ERR_PASSWORD_NEED_SPECIAL = 9;
92  constant int ERR_PASSWORD_IN_HISTORY = 10;
93  constant int ERR_PASSWORD_TOO_SHORT_FOR_SNMP = 11;
94  constant int ERR_INVALID_ARGUMENT = 12;
95  constant int ERR_WRONG_PASSWORD = 13;
96  constant int ERR_SSH_PUBKEY_DATA_TOO_LARGE = 14;
97  constant int ERR_SSH_PUBKEY_INVALID = 15;
98  constant int ERR_SSH_PUBKEY_NOT_SUPPORTED = 16;
99  constant int ERR_SSH_RSA_PUBKEY_TOO_SHORT = 17;
100 
106  UserInfo getInfo();
107 
133  int setAccountPassword(in string password);
134 
167  int updateAccountFull(in string password, in UserInfo info);
168 
175  void getInfoAndPrivileges(out UserInfo info,
176  out vector<Role.Privilege> privileges);
177 
186  int setPreferences(in Preferences prefs);
187 
193  UserCapabilities getCapabilities();
194  };
195 
196 }
boolean usePasswordAsAuthPassphrase
Use account password for SNMPv3 authentication.
Definition: User.idl:14
boolean canSetPreferences
User preferences are modifyable.
Definition: User.idl:77
Pascal.
Definition: User.idl:46
Feet.
Definition: User.idl:41
User Capabilities Describe if certain operations can be performed for user.
Definition: User.idl:75
vector< int > roleIds
List of role ids for this account.
Definition: User.idl:67
string privPassphrase
Privacy passphrase; cannot be read back.
Definition: User.idl:22
pound-force per square inch
Definition: User.idl:47
Meters.
Definition: User.idl:40
string sshPublicKey
Public key for SSH access.
Definition: User.idl:65
boolean havePrivPassphrase
Privacy passphrase present.
Definition: User.idl:21
boolean locked
true if the account cannot be deleted
Definition: User.idl:60
Degrees Celsius.
Definition: User.idl:34
Preferences preferences
User preferences
Definition: User.idl:66
Degrees Fahrenheit.
Definition: User.idl:35
PrivProtocol
SNMP v3 privacy protocol.
Definition: SnmpV3.idl:21
string authPassphrase
Authentication passphrase; cannot be read back.
Definition: User.idl:17
LengthEnum lengthUnit
Display unit for length measurements.
Definition: User.idl:53
boolean haveAuthPassphrase
Authentication passphrase present.
Definition: User.idl:16
TemperatureEnum
Preferred display unit for temperature sensors.
Definition: User.idl:33
User information
Definition: User.idl:58
User preferences
Definition: User.idl:51
boolean blocked
true if the account is blocked due to failed logins
Definition: User.idl:61
um::SnmpV3 PrivProtocol privProtocol
Privacy protocol.
Definition: User.idl:18
User interface
Definition: User.idl:81
TemperatureEnum temperatureUnit
Display unit for temperature sensors.
Definition: User.idl:52
SNMPv3 settings.
Definition: User.idl:10
string telephone
Telephone number.
Definition: User.idl:28
boolean needPasswordChange
true to force a password change on the next login
Definition: User.idl:62
SNMPv3 interface.
Definition: SnmpV3.idl:5
um::SnmpV3 AuthProtocol authProtocol
Authentication protocol.
Definition: User.idl:13
PressureEnum
Preferred display unit for (air) pressure sensors.
Definition: User.idl:45
boolean enabled
SNMPv3 enabled.
Definition: User.idl:11
SnmpV3Settings snmpV3Settings
SNMPv3 settings.
Definition: User.idl:64
um::SnmpV3 SecurityLevel secLevel
Security level.
Definition: User.idl:12
User Management
Definition: Role.idl:7
AuxInfo auxInfo
Auxiliary user information.
Definition: User.idl:63
string eMail
Email address.
Definition: User.idl:29
string fullname
Full name.
Definition: User.idl:27
boolean useAuthPassphraseAsPrivPassphrase
Use authentication passphrase as privacy passphrase.
Definition: User.idl:19
PressureEnum pressureUnit
Display unit for pressure sensors.
Definition: User.idl:54
AuthProtocol
SNMP v3 authentication protocol.
Definition: SnmpV3.idl:15
SecurityLevel
SNMP v3 security level.
Definition: SnmpV3.idl:8
LengthEnum
Preferred display unit for length measurements, e.g.
Definition: User.idl:39
User Management.
Definition: SnmpV3.idl:2
Auxiliary user information.
Definition: User.idl:26
boolean enabled
true if the account is enabled
Definition: User.idl:59
boolean canSetPassword
User password is modifyable.
Definition: User.idl:76