usergroup.get

Description

integer/array usergroup.get(object parameters)

La méthode permet de récupérer des groupes d’utilisateurs selon les paramètres donnés.

Cette méthode est disponible pour les utilisateurs de tout type. 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) Paramètres définissant la sortie souhaitée.

La méthode prend en charge les paramètres suivants.

Parameter Type Description
mfaids ID/array Retourne uniquement les groupes d'utilisateurs avec les méthodes MFA indiquées.

Comportement du paramètre :
- pris en charge pour les utilisateurs de type Super admin (depuis Zabbix 7.0.9)
mfa_status integer Retourne uniquement les groupes d'utilisateurs avec le statut MFA indiqué.

Consultez la page du groupe d'utilisateurs pour obtenir la liste des statuts pris en charge.
status integer Retourne uniquement les groupes d'utilisateurs avec le statut indiqué.

Consultez la page du groupe d'utilisateurs pour obtenir la liste des statuts pris en charge.
userids ID/array Retourne uniquement les groupes d'utilisateurs qui contiennent les utilisateurs indiqués.
usrgrpids ID/array Retourne uniquement les groupes d'utilisateurs avec les ID indiqués.
selectTagFilters query Retourne les permissions des groupes d'utilisateurs basées sur les tags dans la propriété tag_filters.
selectUsers query Retourne les utilisateurs du groupe d'utilisateurs dans la propriété users.

Voir user.get pour les restrictions basées sur le type d'utilisateur.
selectHostGroupRights query Retourne les permissions du groupe d'utilisateurs pour les groupes d'hôtes dans la propriété hostgroup_rights.

Consultez la page du groupe d'utilisateurs pour obtenir la liste des niveaux d'accès aux groupes d'hôtes.
selectTemplateGroupRights query Retourne les permissions du groupe d'utilisateurs pour les groupes de modèles dans la propriété templategroup_rights.

Consultez la page du groupe d'utilisateurs pour obtenir la liste des niveaux d'accès aux groupes de modèles.
limitSelects integer Limite le nombre d'enregistrements renvoyés par les sous-sélections.
output query Propriétés de l'objet groupe d'utilisateurs à renvoyer.

Depuis Zabbix 7.0.9, les utilisateurs de type Admin et User ne peuvent récupérer que les propriétés suivantes : usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Par défaut : extend.
sortfield string/array Trie le résultat selon les propriétés indiquées.

Valeurs possibles : usrgrpid, name.
countOutput boolean Ces paramètres sont décrits dans la commentaire de référence.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Ce paramètre est obsolète, veuillez utiliser selectHostGroupRights ou selectTemplateGroupRights à la place.
Retourne les droits du groupe d'utilisateurs dans la propriété rights.
Consultez la page du groupe d'utilisateurs pour obtenir la liste des niveaux d'accès aux groupes d'hôtes.

Valeurs retournées

(integer/array) Retourne soit:

  • un tableau d'objets ;
  • le nombre d'objets récupérés, si le paramètre countOutput a été utilisé.

Exemples

Récupération des groupes d'utilisateurs activés

Récupérez tous les groupes d'utilisateurs activés.

Requête:

{
    "jsonrpc": "2.0",
    "method": "usergroup.get",
    "params": {
        "output": "extend",
        "status": 0
    },
    "id": 1
}

Réponse :

{
    "jsonrpc": "2.0",
    "result": [
        {
            "usrgrpid": "7",
            "name": "Zabbix administrators",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "8",
            "name": "Guests",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "11",
            "name": "Enabled debug mode",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "1",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "12",
            "name": "No access to the frontend",
            "gui_access": "2",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "14",
            "name": "Read only",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        },
        {
            "usrgrpid": "18",
            "name": "Deny",
            "gui_access": "0",
            "users_status": "0",
            "debug_mode": "0",
            "userdirectoryid": "0",
            "mfa_status": "0",
            "mfaid": "0"
        }
    ],
    "id": 1
}

Voir également

Source

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