usergroup.update
Opis
object usergroup.update(object/array userGroups)
Ta metoda umożliwia aktualizację istniejących grup użytkowników.
Ta metoda jest dostępna wyłącznie dla typu użytkownika Super admin. Uprawnienia do wywoływania tej metody można odebrać w ustawieniach roli użytkownika. Więcej informacji można znaleźć w sekcji Role użytkowników.
Parametry
(object/array) Właściwości grup użytkowników, które mają zostać zaktualizowane.
Właściwość usrgrpid musi być zdefiniowana dla każdej grupy użytkowników, a wszystkie pozostałe właściwości są opcjonalne. Zostaną zaktualizowane tylko przekazane właściwości, a wszystkie pozostałe pozostaną niezmienione.
Oprócz standardowych właściwości grup użytkowników metoda akceptuje następujące parametry.
| Parameter | Type | Description |
|---|---|---|
| hostgroup_rights | object/array | Uprawnienia do grup hostów, które zastąpią bieżące uprawnienia przypisane do grupy użytkowników. |
| proxies | object/array | Proxy, które zostaną powiązane z grupą użytkowników. Proxy muszą mieć zdefiniowaną wyłącznie właściwość proxyid. |
| proxy_groups | object/array | Grupy proxy, które zostaną powiązane z grupą użytkowników. Grupy proxy muszą mieć zdefiniowaną wyłącznie właściwość proxy_groupid. |
| templategroup_rights | object/array | Uprawnienia do grup szablonów, które zastąpią bieżące uprawnienia przypisane do grupy użytkowników. |
| tag_filters | array | Uprawnienia oparte na tagach, które zastąpią bieżące uprawnienia przypisane do grupy użytkowników. |
| users | object/array | Użytkownicy, którzy zastąpią bieżących użytkowników przypisanych do grupy użytkowników. Użytkownik musi mieć zdefiniowaną wyłącznie właściwość userid. |
Zwracane wartości
(object) Zwraca obiekt zawierający identyfikatory zaktualizowanych grup użytkowników we właściwości usrgrpids.
Przykłady
Włączanie grupy użytkowników i aktualizacja uprawnień
Włącz grupę użytkowników i zapewnij jej dostęp do odczytu i zapisu do grup hostów „2” i „4”.
{
"jsonrpc": "2.0",
"method": "usergroup.update",
"params": {
"usrgrpid": "17",
"users_status": "0",
"hostgroup_rights": [
{
"id": "2",
"permission": 3
},
{
"id": "4",
"permission": 3
}
]
},
"id": 1
}
Odpowiedź:
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"17"
]
},
"id": 1
}
Zobacz także
Źródło
CUserGroup::update() w ui/include/classes/api/services/CUserGroup.php.