usergroup.update
Description
object usergroup.update(object/array userGroups)
Cette méthode 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 la méthode peuvent être révoquées dans les paramètres du rôle utilisateur. Voir User roles pour plus d’informations.
Paramètres
(object/array) Propriétés du groupe 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 du groupe d'utilisateurs, la méthode accepte les paramètres suivants.
| Parameter | Type | Description |
|---|---|---|
| hostgroup_rights | object/array | Autorisations du groupe d'hôtes à remplacer par les autorisations actuelles attribuées au groupe d'utilisateurs. |
| templategroup_rights | object/array | Autorisations du groupe de modèles à remplacer par les autorisations actuelles attribuées au groupe d'utilisateurs. |
| tag_filters | array | Autorisations basées sur les tags à remplacer par les autorisations actuelles attribuées au groupe d'utilisateurs. |
| users | object/array | Utilisateurs à remplacer par les utilisateurs actuels attribués au groupe d'utilisateurs. L'utilisateur ne doit avoir défini que la propriété userid. |
| rights (deprecated) |
object/array | Ce paramètre est obsolète, veuillez utiliser hostgroup_rights ou templategroup_rights à la place.Autorisations à attribuer au groupe d'utilisateurs. |
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.