[comment]: # translation:outdated

[comment]: # ({2485e0f7-2485e0f7})
# user.get

[comment]: # ({/2485e0f7-2485e0f7})

[comment]: # ({0fa225e1-36f89e39})
### Descrição  
  
`integer/array user.get(object parameters)`  
  
O método permite recuperar usuários de acordo com os parâmetros fornecidos.  
  
::: noteclassic  
Este método está disponível para usuários de qualquer tipo. As permissões para chamar o método podem ser revogadas nas configurações de função do usuário (uer roles). Consulte [Funções do usuário](/manual/web_interface/frontend_sections/administration/user_roles) para obter mais informações.
:::

[comment]: # ({/0fa225e1-36f89e39})

[comment]: # ({19a52f97-888512e9})
### Parâmetros  
  
`(object)` Parâmetros que definem a saída desejada.
  
O método oferece suporte aos parâmetros a seguir.
  
|Parâmetro|[Tipo](/manual/api/reference_commentary#data_types)|Descrição|
|--|--|------|
|mediaids|string/array|Retorna apenas usuários que usam a mídia fornecida.|  
|mediatypeids|string/array|Retorna apenas usuários que usam os tipos de mídia fornecidos.|  
|userids|string/array|Retorne apenas usuários com os IDs fornecidos.||
|usrgrpids|string/array|Retorna apenas usuários que pertencem aos grupos de usuários especificados.|
|getAccess|flag|Adiciona informações adicionais sobre as permissões do usuário.<br><br>Adiciona as seguintes propriedades para cada usuário:<br>`gui_access` - *(integer)* método de autenticação de frontend do usuário. Consulte a propriedade `gui_access` do [objeto de grupo de usuários](/manual/api/reference/usergroup/object#user_group) para obter uma lista de valores possíveis.<br>`debug_mode` - *(integer)* indica se debug está habilitado para o usuário. Valores possíveis: 0 - depuração desabilitada, 1 - depuração habilitada.<br>`users_status` - *(integer)* indica se o usuário está desabilitado. Valores possíveis: 0 - usuário habilitado, 1 - usuário desabilitado.|
|selectMedias|query|Retorna a mídia usada pelo usuário na propriedade [medias](/manual/api/reference/user/object#media).|
|selectMediatypes|query|Retorna os tipos de mídia usados ​​pelo usuário na propriedade [mediatypes](/manual/api/reference/mediatype/object).|
|selectUsrgrps|query|Retorna grupos de usuários aos quais o usuário pertence na propriedade [usrgrps](/manual/api/reference/usergroup/object).|
|selectRole|query|Retorne a função do usuário na propriedade [role](/manual/api/reference/role/object#role).|
|sortfield|string/array|Classifique o resultado pelas propriedades fornecidas.<br><br>Os valores possíveis são: `userid` e `username`.|
|countOutput|boolean|Esses parâmetros sendo comuns para todos os métodos `get` são descritos em detalhes no [comentário de referência](/manual/api/reference_commentary#common_get_method_parameters).|
|editable|boolean|^|
|excludeSearch|boolean|^|
|filter|object|^|
|limit|integer|^|
|output|query|^|
|preservekeys|boolean|^|
|search|object|^|
|searchByAny|boolean|^|
|searchWildcardsEnabled|boolean|^|
|sortorder|string/array|^|
|startSearch|boolean|^|

[comment]: # ({/19a52f97-888512e9})

[comment]: # ({7223bab1-7223bab1})
### Valores de retorno  
  
`(integer/array)` Retorna:  
  
- uma array de objetos;
- a contagem de objetos recuperados, se o parâmetro `countOutput` foi usado.

[comment]: # ({/7223bab1-7223bab1})

[comment]: # ({b41637d2-b41637d2})
### Exemplos

[comment]: # ({/b41637d2-b41637d2})

[comment]: # ({ceb5a3e9-7b5c610b})
#### Recuperando usuários
  
Recupere todos os usuários configurados.

Request:

```json
{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": "extend"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

```json
{
    "jsonrpc": "2.0",
    "result": [
        {
            "userid": "1",
            "username": "Admin",
            "name": "Zabbix",
            "surname": "Administrator",
            "url": "",
            "autologin": "1",
            "autologout": "0",
            "lang": "en_GB",
            "refresh": "0s",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50",
            "timezone": "default",
            "roleid": "3"
        },
        {
            "userid": "2",
            "username": "guest",
            "name": "",
            "surname": "",
            "url": "",
            "autologin": "0",
            "autologout": "15m",
            "lang": "default",
            "refresh": "30s",
            "theme": "default",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "50",
            "timezone": "default",
            "roleid": "4"
        },
        {
            "userid": "3",
            "username": "user",
            "name": "Zabbix",
            "surname": "User",
            "url": "",
            "autologin": "0",
            "autologout": "0",
            "lang": "ru_RU",
            "refresh": "15s",
            "theme": "dark-theme",
            "attempt_failed": "0",
            "attempt_ip": "",
            "attempt_clock": "0",
            "rows_per_page": "100",
            "timezone": "default",
            "roleid": "1"
        }
    ],
    "id": 1
}
```

[comment]: # ({/ceb5a3e9-7b5c610b})

[comment]: # ({3fab3cdd-d85f9654})
#### Recuperando dados do usuário
  
Recuperar dados de um usuário com ID "12".
Request:

```json
{
    "jsonrpc": "2.0",
    "method": "user.get",
    "params": {
        "output": ["userid", "username"],
        "selectRole": "extend",
        "userids": "12"
    },
    "auth": "038e1d7b1735c6a5436ee9eae095879e",
    "id": 1
}
```

Response:

``` {.java}
{
  "jsonrpc": "2.0",
  "result": [
      {
          "userid": "12",
          "username": "John",
          "role": {
              "roleid": "5",
              "name": "Operator",
              "type": "1",
              "readonly": "0"
          }
      }
  ],
  "id": 1
}
```

[comment]: # ({/3fab3cdd-d85f9654})

[comment]: # ({8d892781-8d892781})
### Veja também

-   [Mídia](/manual/api/reference/user/object#media)
-   [Tipo de mídia](/manual/api/reference/mediatype/object#media_type)
-   [Grupo de usuários](/manual/api/reference/usergroup/object#user_group)
-   [Função](/manual/api/reference/role/object#role)

[comment]: # ({/8d892781-8d892781})

[comment]: # ({842f2a42-842f2a42})
### Fonte

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

[comment]: # ({/842f2a42-842f2a42})