usergroup.get

Descrizione

integer/array usergroup.get(object parameters)

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

Questo metodo è disponibile per utenti di qualsiasi tipo. Le autorizzazioni per richiamare il metodo possono essere revocate nelle impostazioni dei ruoli utente. Per ulteriori informazioni, vedere Ruoli utente.

Parametri

(object) Parametri che definiscono l'output desiderato.

Il metodo supporta i seguenti parametri.

Parametro Tipo Descrizione
mfaids ID/array Restituisce solo i gruppi utenti con i metodi MFA specificati.

Comportamento del parametro:
- supportato per gli utenti di tipo Super admin
mfa_status integer Restituisce solo i gruppi utenti con lo stato MFA specificato.

Per un elenco degli stati supportati, fare riferimento alla pagina dei gruppi utenti.
proxyids ID/array Restituisce solo i gruppi utenti che contengono i proxy specificati.

Comportamento del parametro:
- supportato per gli utenti di tipo Super admin.
proxy_groupids ID/array Restituisce solo i gruppi utenti che contengono i gruppi di proxy specificati.

Comportamento del parametro:
- supportato per gli utenti di tipo Super admin.
selectProxies ID/array Restituisce una proprietà proxies con i proxy del gruppo utenti.

Comportamento del parametro:
- supportato per gli utenti di tipo Super admin.
selectProxyGroups ID/array Restituisce una proprietà proxy_groups con i gruppi di proxy del gruppo utenti.

Comportamento del parametro:
- supportato per gli utenti di tipo Super admin.
status integer Restituisce solo i gruppi utenti con lo stato specificato.

Per un elenco degli stati supportati, fare riferimento alla pagina dei gruppi utenti.
userids ID/array Restituisce solo i gruppi utenti che contengono gli utenti specificati.
usrgrpids ID/array Restituisce solo i gruppi utenti con gli ID specificati.
selectTagFilters query Restituisce le autorizzazioni del gruppo utenti basate sui tag nella proprietà tag_filters.
selectApmFilters query Restituisce le autorizzazioni del gruppo utenti basate su APM nella proprietà apm_filters.

Proprietà supportate: key, value, signal_type.

Predefinito: extend.
selectUsers query Restituisce gli utenti del gruppo utenti nella proprietà users.

Per le limitazioni basate sul tipo di utente, vedere user.get.
selectHostGroupRights query Restituisce le autorizzazioni del gruppo utenti per i gruppi di host nella proprietà hostgroup_rights.

Per un elenco dei livelli di accesso ai gruppi di host, fare riferimento alla pagina dei gruppi utenti.
selectTemplateGroupRights query Restituisce le autorizzazioni del gruppo utenti per i gruppi di template nella proprietà templategroup_rights.

Per un elenco dei livelli di accesso ai gruppi di template, fare riferimento alla pagina dei gruppi utenti.
limitSelects integer Limita il numero di record restituiti dalle sottoquery.
output query Proprietà dell'oggetto gruppo utenti da restituire.

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 nel commento di riferimento.
editable boolean
excludeSearch boolean
filter object
limit integer
preservekeys boolean
search object
searchByAny boolean
searchWildcardsEnabled boolean
sortorder string/array
startSearch boolean

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.