Documentation
Table of Contents
usergroup.get
Descripción
entero/matriz usergroup.get(parámetros de objeto)
El método permite recuperar grupos de usuarios según los parámetros suministrados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método se pueden revocar en la configuración de roles de usuario. Ver Roles de usuario para más información.
Parámetros
(objeto) Parámetros que definen la salida deseada.
El método admite los siguientes parámetros.
| Parámetro | Tipo | Descripción |
|---|---|---|
| status | integer | Devuelve solo grupos de usuarios con el estado dado. Consulte la página del grupo de usuarios para obtener una lista de los estados admitidos. |
| userids | cadena/matriz | Devuelve solo grupos de usuarios que contengan los usuarios dados. |
| usrgrpids | string/array | Devuelve sólo grupos de usuarios con los ID proporcionados. |
| selectTagFilters | query | Devuelve permisos basados en etiquetas de grupo de usuarios en la propiedad tag_filters. Tiene las siguientes propiedades: groupid - (cadena) ID del grupo de host;tag - (cadena) nombre de etiqueta;value - (cadena) valor de etiqueta. |
| selectUsers | query | Devuelve los usuarios del grupo de usuarios en la propiedad usuarios. |
| selectRights | query | Devuelve derechos de grupo de usuarios en la propiedad rights. Tiene las siguientes propiedades: permission - ( entero) nivel de acceso al grupo de hosts;id - (cadena) ID del grupo de hosts.Consulte la página del grupo de usuarios para obtener una lista de niveles de acceso para acoger grupos. |
| limitSelects | integer | Limita el número de registros devueltos por subselecciones. |
| sortfield | string/array | Ordena el resultado según las propiedades dadas. Los valores posibles son: usrgrpid, name. |
| countOutput | boolean | Estos parámetros, que son comunes para todos los métodos get, se describen detalladamente en el comentario de referencia. |
| editable | booleano | |
| excluirBuscar | booleano | |
| filtro | objeto | |
| límite | entero | |
| salida | consulta | |
| preservekeys | booleano | |
| buscar | objeto | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| clasificación | cadena/matriz | |
| iniciarBuscar | booleano |
Valores de retorno
(entero/matriz) Devuelve:
- una matriz de objetos;
- el recuento de objetos recuperados, si el parámetro
countOutputha sido usado.
Ejemplos
Recuperando grupos de usuarios habilitados
Recupera todos los grupos de usuarios habilitados.
Solicitud:
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"usrgrpid": "7",
"name": "Zabbix administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1"
},
{
"usrgrpid": "8",
"name": "Guests",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "11",
"name": "Enabled debug mode",
"gui_access": "0",
"users_status": "0",
"debug_mode": "1"
},
{
"usrgrpid": "12",
"name": "No access to the frontend",
"gui_access": "2",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "14",
"name": "Read only",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
},
{
"usrgrpid": "18",
"name": "Deny",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0"
}
],
"id": 1
}Ver también
Fuente
CUserGroup::get() en ui/include/classes/api/services/CUserGroup.php.