Table of Contents
usergroup.get
Descripción
integer/array usergroup.get(object parameters)
El método permite recuperar grupos de usuarios según los parámetros proporcionados.
Este método está disponible para usuarios de cualquier tipo. Los permisos para llamar al método pueden ser revocados en la configuración de roles de usuario. Consulte Roles de usuario para obtener 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 |
|---|---|---|
| mfaids | ID/array | Devolver solo los grupos de usuarios con los métodos MFA indicados. Comportamiento del parámetro: - soportado para usuarios de tipo Super admin |
| mfa_status | integer | Devolver solo los grupos de usuarios con el estado MFA indicado. Consulte la página de grupo de usuarios para ver una lista de estados soportados. |
| status | integer | Devolver solo los grupos de usuarios con el estado indicado. Consulte la página de grupo de usuarios para ver una lista de estados soportados. |
| userids | ID/array | Devolver solo los grupos de usuarios que contienen los usuarios indicados. |
| usrgrpids | ID/array | Devolver solo los grupos de usuarios con los IDs indicados. |
| selectTagFilters | query | Devolver los permisos basados en etiquetas del grupo de usuarios en la propiedad tag_filters. |
| selectUsers | query | Devolver los usuarios del grupo de usuarios en la propiedad users.Consulte user.get para restricciones basadas en el tipo de usuario. |
| selectHostGroupRights | query | Devolver los permisos de grupo de equipos del grupo de usuarios en la propiedad hostgroup_rights.Consulte la página de grupo de usuarios para ver una lista de niveles de acceso a grupos de equipos. |
| selectTemplateGroupRights | query | Devolver los permisos de grupo de plantillas del grupo de usuarios en la propiedad templategroup_rights.Consulte la página de grupo de usuarios para ver una lista de niveles de acceso a grupos de plantillas. |
| limitSelects | integer | Limita el número de registros devueltos por subconsultas. |
| output | query | Propiedades del objeto grupo de usuarios a devolver. Los usuarios de tipo Admin y User solo pueden recuperar las siguientes propiedades: usrgrpid, name, gui_access, users_status, debug_mode, mfa_status.Por defecto: extend. |
| sortfield | string/array | Ordenar el resultado por las propiedades indicadas. Valores posibles: usrgrpid, name. |
| countOutput | boolean | Estos parámetros se describen en el comentario de referencia. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Devuelve:
- un array de objetos;
- el número de objetos recuperados, si se ha utilizado el parámetro
countOutput.
Ejemplos
Recuperar grupos de usuarios habilitados
Recuperar todos los grupos de usuarios habilitados.
{
"jsonrpc": "2.0",
"method": "usergroup.get",
"params": {
"output": "extend",
"status": 0
},
"id": 1
}Respuesta:
{
"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
}Véase también
Fuente
CUserGroup::get() en ui/include/classes/api/services/CUserGroup.php.