Sidebar

fr:manual:api:reference:usergroup:create

usergroup.create

Description

object usergroup.create(object/array userGroups)

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

Paramètres

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

En plus des propriétés du groupe d'utilisateurs standard, la méthode accepte les paramètres suivants.

Paramètre Type Description
rights object/array Permissions à affecter au groupe.
tag_filters array Permissions par filtre de tag à affecter au groupe.
userids string/array Identifiants des utilisateurs à ajouter au groupe.

Valeurs retournées

(object) Retourne un objet contenant les identifiants des groupes d'utilisateurs créés sous la propriété usrgrpids. L'ordre des ID retournés correspond à l'ordre des groupes d'utilisateurs transmis.

Exemples

Création d'un groupe d'utilisateurs

Créer un groupe d'utilisateurs, qui refuse l'accès au groupe d'hôtes “2”, et y ajouter un utilisateur.

Requête :

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "rights": {
            "permission": 0,
            "id": "2"
        },
        "userids": "12"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}

Réponse :

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

Voir également

Source

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