usergroup.update
Description
object usergroup.update(object/array userGroups)
Cette méthode vous permet de mettre à jour des groupes d'utilisateurs existants.
Cette méthode est disponible uniquement pour le type d'utilisateur Super admin. Les autorisations d'appel de cette méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Consultez User roles pour plus d'informations.
Paramètres
(object/array) Propriétés des groupes d'utilisateurs à mettre à jour.
La propriété usrgrpid doit être définie pour chaque groupe d'utilisateurs ; toutes les autres propriétés sont facultatives. Seules les propriétés transmises seront mises à jour, toutes les autres resteront inchangées.
En plus des propriétés standard des groupes d'utilisateurs, la méthode accepte les paramètres suivants.
| Parameter | Type | Description |
|---|---|---|
| hostgroup_rights | object/array | Permissions des groupes de hôtes qui remplaceront les permissions actuellement attribuées au groupe d'utilisateurs. |
| proxies | object/array | Proxies à associer au groupe d'utilisateurs. Les proxies doivent avoir uniquement la propriété proxyid définie. |
| proxy_groups | object/array | Groupes de proxies à associer au groupe d'utilisateurs. Les groupes de proxies doivent avoir uniquement la propriété proxy_groupid définie. |
| templategroup_rights | object/array | Permissions des groupes de modèles qui remplaceront les permissions actuellement attribuées au groupe d'utilisateurs. |
| tag_filters | array | Permissions basées sur les tags qui remplaceront les permissions actuellement attribuées au groupe d'utilisateurs. |
| users | object/array | Utilisateurs qui remplaceront les utilisateurs actuellement associés au groupe d'utilisateurs. L'utilisateur doit avoir uniquement la propriété userid définie. |
Valeurs retournées
(object) Retourne un objet contenant les identifiants des groupes d'utilisateurs mis à jour sous la propriété usrgrpids.
Exemples
Activation d'un groupe d'utilisateurs et mise à jour des autorisations
Activez un groupe d'utilisateurs et accordez-lui un accès en lecture-écriture aux groupes d'hôtes « 2 » et « 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
}Réponse :
{
"jsonrpc": "2.0",
"result": {
"usrgrpids": [
"17"
]
},
"id": 1
}Voir également
Source
CUserGroup::update() dans ui/include/classes/api/services/CUserGroup.php.