Raritan PX2/PX3 JSON-RPC API
RoleManager.idl
1 #include <Role.idl>
2 #include <UserEvent.idl>
3 
7 module usermgmt {
8 
9  /* event definitions */
13  valueobject RoleEvent extends event.UserEvent {
14  string rolename;
15  };
16 
17  valueobject RoleAdded extends RoleEvent {};
18 
19  valueobject RoleRemoved extends RoleEvent {};
20 
21  valueobject RoleChanged extends RoleEvent {
22  Role.Info oldSettings;
23  Role.Info newSettings;
24  };
25 
27  interface RoleManager {
28 
29  constant int ERR_ROLE_ALREADY_EXISTS = 1;
30  constant int ERR_MAX_ROLES_REACHED = 2;
31  constant int ERR_INVALID_VALUE = 3;
32 
33  constant int ERR_ROLE_DOESNT_EXIST = 1;
34  constant int ERR_ROLE_NOT_DELETABLE = 2;
35 
37  structure ArgumentDesc {
38  string name;
39  string desc;
40  };
41 
43  structure PrivilegeDesc {
44  string name;
45  string desc;
46  vector<ArgumentDesc> args;
47  };
48 
50  structure RoleAccount {
51  int id;
52  string name;
54  };
55 
57  structure Info {
58  vector<PrivilegeDesc> privileges;
59  vector<RoleAccount> roles;
60  };
61 
73  int createRoleFull(in string name, in Role.Info info);
74 
84  int deleteRole(in string name);
85 
91  vector<string> getAllRoleNames();
92 
98  vector<RoleAccount> getAllRoles();
99 
105  vector<PrivilegeDesc> getAllPrivileges();
106 
112  Info getInfo();
113 
114  };
115 
116 }
vector< ArgumentDesc > args
List of supported arguments.
Definition: RoleManager.idl:46
vector< RoleAccount > roles
List of active roles.
Definition: RoleManager.idl:59
Role manager interface.
Definition: RoleManager.idl:27
Role management interface
Definition: Role.idl:10
string name
Argument name.
Definition: RoleManager.idl:38
Full role manager information.
Definition: RoleManager.idl:57
Role information
Definition: Role.idl:21
vector< PrivilegeDesc > privileges
List of supported privileges.
Definition: RoleManager.idl:58
string desc
Privilege description.
Definition: RoleManager.idl:45
Role::Info info
Role information.
Definition: RoleManager.idl:53
int id
Unique role id.
Definition: RoleManager.idl:51
User Management
Definition: Role.idl:7
string name
Privilege name.
Definition: RoleManager.idl:44
Privilege Argument Description.
Definition: RoleManager.idl:37
Privilege Description.
Definition: RoleManager.idl:43
Role information.
Definition: RoleManager.idl:50
valueobject RoleEvent
Base type of all account event.
Definition: RoleManager.idl:14
string desc
Argument description.
Definition: RoleManager.idl:39
string name
Role name.
Definition: RoleManager.idl:52