usergroup.get

Descrizione

integer/array usergroup.get(object parameters)

Questo metodo consente di recuperare i gruppi di utenti in base ai parametri specificati.

Questo metodo è disponibile per utenti di qualsiasi tipo. I permessi per chiamare il metodo possono essere revocati nelle impostazioni del ruolo utente. Vedere User roles per ulteriori informazioni.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parameter Type Description
mfaids ID/array Restituisce solo i gruppi utente con i metodi MFA specificati.

Comportamento del parametro:
- supportato per utenti di tipo Super admin (da Zabbix 7.0.9)
mfa_status integer Restituisce solo i gruppi utente con lo stato MFA specificato.

Consulta la pagina del gruppo utente per un elenco degli stati supportati.
status integer Restituisce solo i gruppi utente con lo stato specificato.

Consulta la pagina del gruppo utente per un elenco degli stati supportati.
userids ID/array Restituisce solo i gruppi utente che contengono gli utenti specificati.
usrgrpids ID/array Restituisce solo i gruppi utente con gli ID specificati.
selectTagFilters query Restituisce i permessi basati sui tag del gruppo utente nella proprietà tag_filters.
selectUsers query Restituisce gli utenti del gruppo utente nella proprietà users.

Vedi user.get per le restrizioni basate sul tipo di utente.
selectHostGroupRights query Restituisce i permessi del gruppo utente per i gruppi host nella proprietà hostgroup_rights.

Consulta la pagina del gruppo utente per un elenco dei livelli di accesso ai gruppi host.
selectTemplateGroupRights query Restituisce i permessi del gruppo utente per i gruppi template nella proprietà templategroup_rights.

Consulta la pagina del gruppo utente per un elenco dei livelli di accesso ai gruppi template.
limitSelects integer Limita il numero di record restituiti dalle sotto-selezioni.
output query Proprietà dell'oggetto gruppo utente da restituire.

Da Zabbix 7.0.9, gli utenti di tipo Admin e User possono recuperare solo le seguenti proprietà: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.

Predefinito: extend.
sortfield string/array Ordina il risultato in base alle proprietà specificate.

Valori possibili: usrgrpid, name.
countOutput boolean Questi parametri sono descritti nella nota di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean
selectRights
(deprecated)		 query Questo parametro è deprecato, usa invece selectHostGroupRights o selectTemplateGroupRights.
Restituisce i diritti del gruppo utente nella proprietà rights.
Consulta la pagina del gruppo utente per un elenco dei livelli di accesso ai gruppi host.

Valori restituiti

(integer/array) Restituisce o:

  • una matrice di oggetti;
  • il conteggio degli oggetti recuperati, se il parametro countOutput è stato usato.

Esempi

Recupero dei gruppi utenti abilitati

Recupera tutti i gruppi utenti abilitati.

Richiesta:

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

Risposta:

{
    "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
}

Guarda anche

Fonte

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