Documentation
Table of Contents
user.get
¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨®
integer/array user.get(object parameters)
El m¨¨tode permet recuperar usuaris segons els par¨¤metres prove?ts.
Aquest m¨¨tode ¨¦s disponible per a usuaris de qualsevol mena. Els permisos per cridar al m¨¨tode es poden revocar a les configuracions de rols d'usuari. Per a m¨¦s informaci¨®, veieu Rols d'usuari.
±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ
(object) ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð²õ que defineixen la sortida esperada.
El m¨¨tode admet els par¨¤metres seg¨¹ents.
Des de Áú»¢¶Ä²© 7.2.3, quan sol¡¤liciten mitjans d'usuari, permisos o informaci¨® de rol, els usuaris de tipus Administrador i Usuari nom¨¦s poden recuperar dades del seu propi usuari.Per obtenir un exemple, vegeu Recuperaci¨® d'usuaris com a Administrador.
| ±Ê²¹°ù¨¤³¾±ð³Ù°ù±ð | Tipus | ¶Ù±ð²õ³¦°ù¾±±è³¦¾±¨® |
|---|---|---|
| mediaids | ID/array | Retorna nom¨¦s els usuaris que s¨®n emprant el suport donat. |
| mediatypeids | ID/array | Retorna nom¨¦s els usuaris que empren els tipus de suport donats. |
| userids | ID/array | Retorna nom¨¦s els usuaris amb els identificadors donats. |
| usrgrpids | ID/array | Retorna nom¨¦s els usuaris que pertanyen als grups d'usuaris donats. |
| getAccess | flag | Afegeix informaci¨® addicional sobre els permisos d'usuari. Afegeix les propietats seg¨¹ents per a cada usuari: gui_access - (integer) m¨¨tode d'autenticaci¨® frontal de l'usuari. Consulteu la propietat gui_access de l'objecte de grup d'usuaris per pbtomdre una llista de possibles valors.debug_mode - ( integer) indica si el mode de depuraci¨® ¨¦s habilitat per a l'usuari. Valors possibles: 0 - depuraci¨® desactivada, 1 - depuraci¨® activada.users_status - (integer) indica si l'usuari ¨¦s desactivat. Valors possibles: 0 - usuari actiu, 1 - usuari desactivat. |
| selectMedias | query | Retorna el suport emprat per l'usuari a la propietat suports. |
| selectMediatypes | query | Retorna els tipus de suport emprats per l'usuari a la propietat mediatypes. See mediatype.get for restrictions based on user type. |
| selectUsrgrps | query | Retorna els grups d'usuaris als quals pertany l'usuari a la propietat usrgrps. |
| selectRole | query | Retorna el rol d'usuari a la propietat rol. |
| filter | objecte | Retorna nom¨¦s aquells resultats que coincideixen exactament amb el filtre donat. Accepta un objecte, on les claus s¨®n noms de propietat i els valors s¨®n un valor ¨²nic o una matriu de valors amb els quals coincideix. No admet propietats de text tipus de dades. object](/manual/api/reference/user/object) per als usuaris de tipus Admin i User quan demanen dades sobre usuaris del seu grup d'usuaris (des de Áú»¢¶Ä²© 7.2.3): identificador, nom, cognom, nom d'usuari. |
| output | query | User object propietats que s'han de tornar. Des de Áú»¢¶Ä²© 7.2.3, els usuaris de tipus Admin i User nom¨¦s poden recuperar les propietats seg¨¹ents: - Per al seu propi usuari: userid, attempt_tempttt``, ``attempt_tempttlock,autologout,lang,name,provisioned,refresh,roleid,rows_per_page,cognom,theme,timezone,url,username., : nom d'usuari.Per defecte: extend. |
| search | objecte | Retorna resultats que coincideixen amb el patr¨® donat (no distingeix entre maj¨²scules i min¨²scules). Accepta un objecte, on les claus s¨®n noms de propietat i els valors s¨®n cadenes per cercar. Si no es donen opcions addicionals, es far¨¤ una cerca M'agrada "%...%".Nom¨¦s admet propietats de string i text tipus de dades.Possible User object al seu grup d'usuaris (des de Áú»¢¶Ä²© 7.2.3): nom, cognom, nom d'usuari. |
| sortfield | string/array | Ordena el resultat per les propietats donades. Els valors possibles s¨®n: userid i username. |
| countOutput | boolean | Aquests par¨¤metres es descriuen als comentaris de refer¨¨ncia. |
| editable | boolean | |
| excludeSearch | boolean | |
| limit | integer | |
| preservekeys | boolean | |
| searchByAny | boolean | |
| searchWildcardsEnabled | boolean | |
| sortorder | string/array | |
| startSearch | boolean |
Valors de retorn
(integer/array) Retorna un d'entre:
- una taula d'objectes;
- el recompte d'objectes recuperats, si s'empra el par¨¤metre
countOutput.
Exemples
Recuperar usuaris
Recupera tots els usuaris configurats.
Resposta:
{
"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
}Recuperar usuaris com a Administrador
Com a usuari de tipus Administrador, recupera dades detallades sobre el teu propi usuari i dades limitades per als usuaris del teu grup d'usuaris.
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": "extend",
"getAccess": true,
"selectMedias": "extend",
"selectMediatypes": "extend",
"selectUsrgrps": "extend",
"selectRole": "extend"
},
"id": 1
}Resposta:
{
"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
}Recuperar informaci¨® de l'usuari
Recupera la informaci¨® de l'usuari amb ID "12".
{
"jsonrpc": "2.0",
"method": "user.get",
"params": {
"output": ["userid", "username"],
"selectRole": "extend",
"userids": "12"
},
"id": 1
}Resposta:
{
"jsonrpc": "2.0",
"result": [
{
"userid": "12",
"username": "John",
"role": {
"roleid": "5",
"name": "Operator",
"type": "1",
"readonly": "0"
}
}
],
"id": 1
}Veieu tamb¨¦
Font
CUser::get() in ui/include/classes/api/services/CUser.php.