usergroup.create

Description

object usergroup.create(object/array userGroups)

Cette méthode vous permet de créer de nouveaux groupes d'utilisateurs.

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. Consultez Rôles utilisateur pour plus d'informations.

Paramètres

(object/array) Groupes d'utilisateurs à créer.

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 d'hôtes à attribuer au groupe d'utilisateurs.
proxies object/array Proxies à associer au groupe d'utilisateurs.
Les proxies doivent uniquement avoir la propriété proxyid définie.
proxy_groups object/array Groupes de proxies à associer au groupe d'utilisateurs.
Les groupes de proxies doivent uniquement avoir la propriété proxy_groupid définie.
templategroup_rights object/array Permissions des groupes de modèles à attribuer au groupe d'utilisateurs.
tag_filters array Permissions basées sur les tags à attribuer au groupe d'utilisateurs.
users object/array Utilisateurs à ajouter au groupe d'utilisateurs.

L'utilisateur doit uniquement avoir la propriété userid définie.

Valeurs de retour

(object) Renvoie un objet contenant les ID des groupes d’utilisateurs créés dans la propriété usrgrpids. L’ordre des ID renvoyés correspond à l’ordre des groupes d’utilisateurs transmis.

Exemples

Création d’un groupe d’utilisateurs

Créez un groupe d’utilisateurs Operation managers avec un accès refusé au groupe d’hôtes "2", et ajoutez-y un utilisateur.

Requête :

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "hostgroup_rights": {
            "id": "2",
            "permission": 0
        },
        "users": [
            {
                "userid": "12"
            }
        ]
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": {
        "usrgrpids": [
            "20"
        ]
    },
    "id": 1
}

Voir également

Source

CUserGroup::create() dans ui/include/classes/api/services/CUserGroup.php.