Documentation
Table of Contents
user.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô
integer/array user.get(object parameters)
El m¨¦todo permite recuperar usuarios seg¨²n los par¨¢metros dados.
Este m¨¦todo est¨¢ disponible para usuarios de cualquier tipo. Los permisos para llamar al m¨¦todo se puede revocar en la configuraci¨®n de roles de usuario. Ver Roles de usuario para obtener m¨¢s informaci¨®n.
±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ
(object) ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç²õ que definen la salida deseada.
El m¨¦todo admite los siguientes par¨¢metros.
| ±Ê²¹°ù¨¢³¾±ð³Ù°ù´Ç | Tipo | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®²Ô |
|---|---|---|
| mediaids | ID/matriz | Devuelve solo los usuarios que usan el medio indicado. |
| mediatypeids | ID/matriz | Devuelve solo los usuarios que usan los tipos de medios indicados. |
| userids | ID/matriz | Devuelve solo los usuarios con las ID indicadas. |
| usrgrpids | ID/matriz | Devuelve solo los usuarios que pertenecen a los grupos de usuarios indicados. |
| getAccess | flag | Agrega informaci¨®n adicional sobre los permisos de usuario. Agrega las siguientes propiedades para cada usuario: gui_access - (entero) m¨¦todo de autenticaci¨®n de interfaz del usuario. Consulte la propiedad gui_access del objeto de grupo de usuarios para obtener una lista de valores posibles.debug_mode - (entero) indica si la depuraci¨®n est¨¢ habilitada para el usuario. Valores posibles: 0 - depuraci¨®n deshabilitada, 1 - depuraci¨®n habilitada.users_status - (entero) indica si el usuario est¨¢ deshabilitado. Valores posibles: 0 - usuario habilitado, 1 - usuario deshabilitado. |
| selectMedias | query | Devuelve el medio utilizado por el usuario en la propiedad medias. |
| selectMediatypes | query | Devuelve los tipos de medios utilizados por el usuario en la propiedad mediatypes.Consulta mediatype.get para conocer las restricciones basadas en el tipo de usuario. |
| selectUsrgrps | query | Devuelve los grupos de usuarios a los que pertenece el usuario en la propiedad usrgrps. |
| selectRole | query | Devuelve el rol del usuario en la propiedad role. |
| sortfield | cadena/matriz | Ordena el resultado por las propiedades indicadas. Valores posibles: userid, username. |
| countOutput | booleano | Estos par¨¢metros, que son comunes para todos los m¨¦todos get, se describen en detalle en el comentario de referencia. |
| editable | booleano | |
| excludeSearch | booleano | |
| filter | object | |
| limit | entero | |
| output | query | |
| preservekeys | booleano | |
| search | object | |
| searchByAny | booleano | |
| searchWildcardsEnabled | booleano | |
| sortorder | cadena/matriz | |
| startSearch | 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 usuarios
Recuperar todos los usuarios configurados.
Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"surname": "Administrator",
"url": "",
"autologin": "1",
"autologout": "0",
"lang": "en_US",
"refresh": "0s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "3",
"userdirectoryid": "0",
"ts_provisioned": "0"
},
{
"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",
"userdirectoryid": "0",
"ts_provisioned": "0"
},
{
"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",
"userdirectoryid": "0",
"ts_provisioned": "0"
}
],
"id": 1
}Retrieving users as Admin
As an Admin type user, retrieve detailed data about your own user and limited data for users in your user group.
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}Response:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "1",
"username": "Admin",
"name": "Áú»¢¶Ä²©",
"surname": "Administrator",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Áú»¢¶Ä²© administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"mfa_status": "0"
}
]
},
{
"userid": "3",
"username": "database-admin",
"name": "John",
"surname": "Doe",
"url": "",
"autologin": "0",
"autologout": "0",
"lang": "default",
"refresh": "30s",
"theme": "default",
"attempt_failed": "0",
"attempt_ip": "",
"attempt_clock": "0",
"rows_per_page": "50",
"timezone": "default",
"roleid": "2",
"provisioned": "0",
"gui_access": "0",
"debug_mode": "0",
"users_status": "0",
"usrgrps": [
{
"usrgrpid": "7",
"name": "Áú»¢¶Ä²© administrators",
"gui_access": "0",
"users_status": "0",
"debug_mode": "0",
"mfa_status": "0"
}
],
"medias": [
{
"mediaid": "2",
"mediatypeid": "1",
"sendto": [
"[email protected]"
],
"active": "0",
"severity": "63",
"period": "1-7,00:00-24:00",
"provisioned": 0
}
],
"mediatypes": [
{
"mediatypeid": "1",
"type": "0",
"name": "Email",
"status": "0",
"description": "",
"maxattempts": "3"
}
],
"role": {
"roleid": "2",
"name": "Admin role",
"type": "2",
"readonly": "0"
}
}
],
"id": 1
}Recuperando datos de usuario
Recuperar datos de un usuario con ID "12".
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"id": 1
}Respuesta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Ver tambi¨¦n
Fuente
CUser::get() en ui/include/classes/api/services/CUser.php.