Documentation
Table of Contents
user.get
Descri??o
integer/array user.get(object parameters)
O m¨¦todo permite recuperar usu¨¢rios de acordo com os par?metros fornecidos.
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 para obter mais informa??es.
Par?metros
(object) Par?metros que definem a sa¨ªda desejada.
O m¨¦todo oferece suporte aos par?metros a seguir.
| Par?metro | Tipo | 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. Adiciona as seguintes propriedades para cada usu¨¢rio: 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 para obter uma lista de valores poss¨ªveis.debug_mode - (integer) indica se debug est¨¢ habilitado para o usu¨¢rio. Valores poss¨ªveis: 0 - depura??o desabilitada, 1 - depura??o habilitada.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. |
| selectMediatypes | query | Retorna os tipos de m¨ªdia usados ??pelo usu¨¢rio na propriedade mediatypes. |
| selectUsrgrps | query | Retorna grupos de usu¨¢rios aos quais o usu¨¢rio pertence na propriedade usrgrps. |
| selectRole | query | Retorne a fun??o do usu¨¢rio na propriedade role. |
| sortfield | string/array | Classifique o resultado pelas propriedades fornecidas. 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. |
| editable | boolean | |
| excludeSearch | boolean | |
| filter | object | |
| limit | integer | |
| output | query | |
| preservekeys | boolean | |
| search | object | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valores de retorno
(integer/array) Retorna:
- uma array de objetos;
- a contagem de objetos recuperados, se o par?metro
countOutputfoi usado.
Exemplos
Recuperando usu¨¢rios
Recupere todos os usu¨¢rios configurados.
Request:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"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": "Áú»¢¶Ä²©",
"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
}Recuperando dados do usu¨¢rio
Recuperar dados de um usu¨¢rio com ID "12". Request:
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"auth": "038e1d7b1735c6a5436ee9eae095879e",
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Veja tamb¨¦m
Fonte
CUser::get() in ui/include/classes/api/services/CUser.php.