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 seulement disponible pour les utilisateurs du type Super admin. Les autorisations d'appeler la méthode peuvent être révoquées dans les paramètres de rôle d'utilisateur. Voir Rôles utilisateur pour plus d'informations.

Paramètres

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

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

Paramètre Type Description
rights object/array Autorisations à assigner au groupe.
tag_filters array Autorisations basées sur les balises à assigner au groupe.
users object/array Utilisateurs à ajouter au groupe d'hôtes.

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

Valeurs retournées

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

Exemples

Création d'un groupe d'utilisateurs

Créez un groupe d'utilisateurs qui refuse l'accès au groupe d'hôtes "2" et ajoutez-y un utilisateur.

Requête :

{
    "jsonrpc": "2.0",
    "method": "usergroup.create",
    "params": {
        "name": "Operation managers",
        "rights": {
            "permission": 0,
            "id": "2"
        },
        "users": [
            {"userid": "12"}
        ]
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "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.