1 package PVE
::API2
::Group
;
5 use PVE
::Cluster qw
(cfs_read_file cfs_write_file
);
6 use PVE
::AccessControl
;
9 use PVE
::JSONSchema
qw(get_standard_option register_standard_option);
11 use base
qw(PVE::RESTHandler);
13 register_standard_option
('group-id', {
15 format
=> 'pve-groupid',
16 completion
=> \
&PVE
::AccessControl
::complete_group
,
19 register_standard_option
('group-comment', { type
=> 'string', optional
=> 1 });
21 __PACKAGE__-
>register_method ({
25 description
=> "Group index.",
27 description
=> "The returned list is restricted to groups where you have 'User.Modify', 'Sys.Audit' or 'Group.Allocate' permissions on /access/groups/<group>.",
31 additionalProperties
=> 0,
39 groupid
=> get_standard_option
('group-id'),
40 comment
=> get_standard_option
('group-comment'),
43 links
=> [ { rel
=> 'child', href
=> "{groupid}" } ],
50 my $rpcenv = PVE
::RPCEnvironment
::get
();
51 my $usercfg = cfs_read_file
("user.cfg");
52 my $authuser = $rpcenv->get_user();
54 my $privs = [ 'User.Modify', 'Sys.Audit', 'Group.Allocate'];
56 foreach my $group (keys %{$usercfg->{groups
}}) {
57 next if !$rpcenv->check_any($authuser, "/access/groups/$group", $privs, 1);
58 my $data = $usercfg->{groups
}->{$group};
59 my $entry = { groupid
=> $group };
60 $entry->{comment
} = $data->{comment
} if defined($data->{comment
});
67 __PACKAGE__-
>register_method ({
68 name
=> 'create_group',
73 check
=> ['perm', '/access/groups', ['Group.Allocate']],
75 description
=> "Create new group.",
77 additionalProperties
=> 0,
79 groupid
=> get_standard_option
('group-id'),
80 comment
=> get_standard_option
('group-comment'),
83 returns
=> { type
=> 'null' },
87 PVE
::AccessControl
::lock_user_config
(
90 my $usercfg = cfs_read_file
("user.cfg");
92 my $group = $param->{groupid
};
94 die "group '$group' already exists\n"
95 if $usercfg->{groups
}->{$group};
97 $usercfg->{groups
}->{$group} = { users
=> {} };
99 $usercfg->{groups
}->{$group}->{comment
} = $param->{comment
} if $param->{comment
};
102 cfs_write_file
("user.cfg", $usercfg);
103 }, "create group failed");
108 __PACKAGE__-
>register_method ({
109 name
=> 'update_group',
114 check
=> ['perm', '/access/groups', ['Group.Allocate']],
116 description
=> "Update group data.",
118 additionalProperties
=> 0,
120 groupid
=> get_standard_option
('group-id'),
121 comment
=> get_standard_option
('group-comment'),
124 returns
=> { type
=> 'null' },
128 PVE
::AccessControl
::lock_user_config
(
131 my $usercfg = cfs_read_file
("user.cfg");
133 my $group = $param->{groupid
};
135 my $data = $usercfg->{groups
}->{$group};
137 die "group '$group' does not exist\n"
140 $data->{comment
} = $param->{comment
} if defined($param->{comment
});
142 cfs_write_file
("user.cfg", $usercfg);
143 }, "update group failed");
148 __PACKAGE__-
>register_method ({
149 name
=> 'read_group',
153 check
=> ['perm', '/access/groups', ['Sys.Audit', 'Group.Allocate'], any
=> 1],
155 description
=> "Get group configuration.",
157 additionalProperties
=> 0,
159 groupid
=> get_standard_option
('group-id'),
164 additionalProperties
=> 0,
166 comment
=> get_standard_option
('group-comment'),
169 items
=> get_standard_option
('userid-completed')
176 my $group = $param->{groupid
};
178 my $usercfg = cfs_read_file
("user.cfg");
180 my $data = $usercfg->{groups
}->{$group};
182 die "group '$group' does not exist\n" if !$data;
184 my $members = $data->{users
} ?
[ keys %{$data->{users
}} ] : [];
186 my $res = { members
=> $members };
188 $res->{comment
} = $data->{comment
} if defined($data->{comment
});
194 __PACKAGE__-
>register_method ({
195 name
=> 'delete_group',
200 check
=> ['perm', '/access/groups', ['Group.Allocate']],
202 description
=> "Delete group.",
204 additionalProperties
=> 0,
206 groupid
=> get_standard_option
('group-id'),
209 returns
=> { type
=> 'null' },
213 PVE
::AccessControl
::lock_user_config
(
216 my $usercfg = cfs_read_file
("user.cfg");
218 my $group = $param->{groupid
};
220 die "group '$group' does not exist\n"
221 if !$usercfg->{groups
}->{$group};
223 delete ($usercfg->{groups
}->{$group});
225 PVE
::AccessControl
::delete_group_acl
($group, $usercfg);
227 cfs_write_file
("user.cfg", $usercfg);
228 }, "delete group failed");