flexideo

Požadavek get-user

Informace o přihlášeném uživateli

Požadavek na získání základních informací o aktuálně přihlášeném uživateli. V případě administrátora, je možné získat informace i o jiných uživatelích.

syntax 
<request>
<get-user
id="{number}"
/>
</request>

Atributy

id - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)


Potomci

Požadavek get-user neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty. Uzel nemá povolen prázdný obsah.


Poznámka k request

Není-li atribut id uveden (a těsně po přihlášení uživatele přihlašovacím jménem a heslem ani znám není), vrací server informace o aktuálně přihlášeném uživateli (vč. zmíněného id). Pozor na jednu věc. pokud neznáte aktuální id (pdk) požadovaného uživatele, nenechávejte atribut prázdný, server bude hledat prázdný identifikátor a vrátí chybu "Nerozpoznane id"!


Odpověď

Uzel s informacemi o uživateli.

Struktura odpovědi na požadavek get-user vrácená v obálce response:

syntax 
<response>
<user-details
type="ok|error"
id="{number}"
userid="{string}"
role="{number}"
name="{string}"
lastlogon="{date}"
valid="{boolean}"
live="{boolean}"
online="{boolean}"
email="{string}"
phone="{string}"
mobile="{string}"
address="{string}"
division="{number}"
team="{string}"
function="{string}"
assistant="{string}"
notes="{string}"
lang="{string}"
sync="{boolean}"
adduser="{string}"
half_sync="{boolean}"
full_sync="{boolean}"
sms_auth="{string}"
p_admin="{boolean}"
p_db="{boolean}"
p_stat="{boolean}"
p_guest="{boolean}"
p_import="{boolean}"
p_export="{boolean}"
p_unlock="{boolean}"
p_live="{boolean}"
p_manage="{boolean}"
p_power="{boolean}"
p_pubsaves="{boolean}"
p_efiles="{boolean}"
/>
</response>

Atributy

type - Obsahuje hodnoty ok nebo error (možnosti obsahu: ok | error)

id - číslo uživatele - User ID pro správnou identifikaci souboru nastavení (statistiky).(typ: number)

userid - Přihlašovací jméno uživatele (login)(typ: string) TYP HODNOTY: string;

role - Číslo role daného uživatele(typ: number) TYP HODNOTY: number;

name - Zobrazované jméno uživatele.(typ: string) TYP HODNOTY: string;

lastlogon - datum posledního přihlášení uživatele(typ: date) TYP HODNOTY: date;

valid - zda je uživatel ještě platný nebo je smazaný, či v archivu.(typ: boolean) TYP HODNOTY: boolean;

live - zda má uživatel oprávnění přihlašovat se v live režimu - tj. zejm. pomocí add-on.(typ: boolean) TYP HODNOTY: boolean;

online - zda je uživatel právě přihlášen v live režimu (nejde o přihlášení např. do intranetu, ale o živé připojení pro příjem zpráv pomocí tzv. add-on).(typ: boolean) TYP HODNOTY: boolean;

email - jedna hlavní e-mailová adresa(typ: string) TYP HODNOTY: string;

phone - jedno nebo více telefonních čísel, záleží na způsobu využití kolonky v Systému(typ: string) TYP HODNOTY: string;

mobile - jedno nebo více mobilních telefonních čísel, záleží na způsobu využití kolonky v Systému(typ: string) TYP HODNOTY: string;

address - pole pro zadání (většinou pracovní) kontaktní adresy pro kamenou poštu;(typ: string) TYP HODNOTY: string;

division - číslo pro účely třídění uživatelů na divize či oddělení;(typ: number) TYP HODNOTY: number;

team - název týmu či oddělení, ve kterém je uživatel zařazen jako pracovník (člen týmu/skupiny);(typ: string) TYP HODNOTY: string;

function - pracovní / formální funkce daného uživatele jako člena týmu / skupiny;(typ: string) TYP HODNOTY: string;

assistant - kontakt na asistenta či zasupujícího spolupracovníka v libovolné podobě;(typ: string) TYP HODNOTY: string;

notes - poznámky či jiné specifické údaje k uživateli;(typ: string) TYP HODNOTY: string;

lang - nastavení jazyka používaného uživatelem; tato zkratka pak řídí jazyk, v jakém s uživatelem komunikují uživatelské programy; měly by být využívány zkratky jako např. cs, en apod.; tyto zkratky jsou pak dosazovány do cesty k jazykovému souboru při jeho načítání s podsložky lang webového sídla Systému;(typ: string) TYP HODNOTY: string;

sync - volba u uživatele aktivuje průběžnou synchronizaci s poštovní schránkou a případně i jinými složkami (více viz. nastavení parametrů app-type v definici některých dokumentů);(typ: boolean) TYP HODNOTY: boolean;

adduser - v případě zatržení volby sync je zapotřebí i tento údaj, který udává uživatelské přihlašovací jméno do schránky;(typ: string) TYP HODNOTY: string;

half_sync - jako doplňěk volby sync je možné použít i tuto volbu, která při zatržení zajistí, že budou synchronizovány jen položky odchozí pošty generované Systémem a to ze schránky určené vlastností adduser; bývá využito v případech, kdy jméno jedna konkrétní hodnota (jméno) adduser bývá vužito více než jedním uživatelem Systému a docházelo by tak ke konfliktu příchozí pošty či jiné obousměrné synchronizace; volba tak zajistí možnost bezproblémového odesílání z anonymních schránek, kterými bývají jména jako (recepce, info, helpdesk apod.);(typ: boolean) TYP HODNOTY: boolean;

full_sync - v případě zatržení volby sync a poloviční synchronizaci buď vynucené více jmény nebo dané volbou half_sync (viz. vysvětlení u předchozí volby half_sync), může být u jednoho z uživatelů používajících společné jméno v adduser zatržena volba pro plnou (obousměrnou) synchronizaci tak, aby tento uživatel měl přístup i k příchozím a jiným položkám z dané - většinou anonymní - schránky; při zatržení full_sync u více než jednoho uživatele ve skupině sdílející jedno jméno adduser bude obousměrná synchronizace vypnuta u všech v této skupině;(typ: boolean) TYP HODNOTY: boolean;

sms_auth - zapíná SMS autentifikaci pro daného uživatele, pokud je nastavena na hodnotu y (yes); hodnota p (public) vyvolává SMS autentifikaci při přihlašování daného uživatele pouze v případě, že se připojuje z veřejné sítě; n (no) a všechny ostatní hodnoty vč. NULL či nemapování znamenají úplné vynutí SMS autentifikace;(typ: string) TYP HODNOTY: string;

p_admin - volba indikuje administrátora, který zatržením této volby získává všechna práva a možnosti plynoucí z následujících voleb, které se již u administrátora tak nemusí zatrhávat;(typ: boolean) TYP HODNOTY: boolean;

p_db - umožňuje provádět změny v databázi, zejména úprava struktury dle nových DAD;(typ: boolean) TYP HODNOTY: boolean;

p_stat - zpřístupňuje uživateli údaje ze statistik činnosti serveru Systému, získávané specifickým požadavkem na statistiky;(typ: boolean) TYP HODNOTY: boolean;

p_guest - uživatel s touto nastavenou volbou bude využíván pro anonymní připojení; jde o specifické potřeby či speciální potřeby konkrétní aplikace;(typ: boolean) TYP HODNOTY: boolean;

p_import - tato volba umožňuje uživateli na server podávat a provádět požavky na import specifickými požadavky pro import;(typ: boolean) TYP HODNOTY: boolean;

p_export - tato volba umožňuje uživateli na server podávat a provádět požavky na export specifickými požadavky pro export;(typ: boolean) TYP HODNOTY: boolean;

p_unlock - umožňuje uživateli odesílat požadavky na admin-unlock, což jsou specifické zásahy v případě obecných zámků a zámků XML entit ukládaných serverem;(typ: boolean) TYP HODNOTY: boolean;

p_live - umožňuje uživateli využívat obecnou či speciální aplikační utilitu pro příjem zpráv ze serveru a provádění následných úkonů (tzv. addOn frame-work);(typ: boolean) TYP HODNOTY: boolean;

p_manage - umožňuje uživateli řídit (zejm. zastavovat a spouštět) server Systému;(typ: boolean) TYP HODNOTY: boolean;

p_power - stanovuje uživatele jako dobře znalého aplikační problematiky a umožňuje mu ukládat společná nastavení (entity corporate-table), která jsou podkladem pro sdílený intranet Systému;(typ: boolean) TYP HODNOTY: boolean;

p_pubsaves - dává uživateli oprávnění ukládat soubory pomocí požadavků save-file do virt. složek, které nejsou nastaveny jako uživatelské (user-saves='true');(typ: boolean) TYP HODNOTY: boolean;

p_efiles - se jedná o povolení připojovat přílohy externě pomocí atributu source uvedeného v ukládaném dokumentu u odkazů file/image + přílohy.(typ: boolean) TYP HODNOTY: boolean;


Potomci

Odpověď user-details neobsahuje žádné další elementy, ani žádné jiné číselné či řetězcové hodnoty.

Výraz pro identifikaci chyb v odpovědi serveru: user-details[@type='error'] (odkaz na popis detailu: @detail).


Poznámka k response

Pokud o detail uživatele žádá administrátor, tak vedle toho, že může žádat o informace o někom jiném, je toho obdržený seznam též rozšířen o následující administrátorské informace "r_...".

Uživatelé se přihlašují pod svými přihlašovacími jmény evidovanými přímo v databázi flexideo - standardně není využíván active-directory. Informace o uživatelích jsou ukládány stejným způsobem jako i ostatní data aplikace, tedy formou XML dokumentů rozkládaných do SQL databáze (viz. registr uživatelů). Mají však jistá povinná políčka a některá základní z těchto povinných políček je možné získávat efektivní formou pomocí požadavku get-user. Primární klíč dokumentů registru uživatelů (pdk) flexideo server užívá jako identifikátor uživatele, zejména pak jako autora aplikačních dokumentů. Přehled uživatelů je k dsipozici dle bezpečnostních nastavení prováděných prostřednictvím XDS potřebným uživatelům.

Význam jednotlivých hodnot byl již popsán v rámci definování XDS vlastnosti mapp-to-user v rámci definice registru uživatelů.


Identifikace chyb

V případě, že zadáte id, které neexistuje (např. 1000, za předpokladu že tolik uživatelů není), bude odpověď následující:

<user-details type="error" id="1000" detail="Nenalezen"/>

Zadáte-li hodnotově neplatný atribut (prázdný, nečíselný nebo menší než nula), odpověď bude následující:

<user-details type="error" id="-1" detail="Nerozpoznane id"/>

Požadavek get-userPožadavek change-passwordPožadavek actionPožadavek send-requestPožadavek send-messagePožadavek confirm-messagePožadavek get-messagesPožadavek tranformPožadavek set-tempPožadavek get-tempPožadavek general-lockPožadavek encryptPožadavek decryptPožadavek max-keyPožadavek reload-sslPožadavek get-versionsPožadavek uuidPožadavek cnthashPožadavek rand