usergroup.create

Description

object usergroup.create(object/array userGroups)

Cette méthode 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. Voir User roles 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.

Paramètre Type Description
hostgroup_rights object/array Autorisations de groupes d’hôtes à attribuer au groupe d’utilisateurs.
templategroup_rights object/array Autorisations de groupes de modèles à attribuer au groupe d’utilisateurs.
tag_filters array Autorisations basées sur les tags à attribuer au groupe d’utilisateurs.
users object/array Utilisateurs à ajouter au groupe d’utilisateurs.

L’utilisateur doit avoir uniquement 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.