Webová služba UserAdministration verze 1.0.0 (Obecné webové služby) - popis rozhraní služby

Vygenerováno z verze 4.21.0.19.0.

Podmínky omezující zveřejnění

Autorem tohoto dokumentu je společnost MARBES CONSULTING s.r.o. Dokument obsahuje informace důvěrného charakteru a ve smyslu definice autorského práva (viz § 2, odst. 1 Zákona č. 121/2000 Sb., zákon o právu autorském) je duševním vlastnictvím autora a předmětem práva autorského. Dokument smí být použit výhradně za účelem, za kterým byl poskytnut a nesmí být bez předchozího souhlasu autora citován, kopírován, vytěžován1 nebo předán třetí fyzické či právnické osobě.

© 2009 MARBES CONSULTING s.r.o.

1 Vytěžováním se podle zákona č. 121/2000 Sb. rozumí trvalý nebo dočasný přepis celého obsahu nebo jeho podstatné části na jiný podklad, a to jakýmikoli prostředky nebo jakýmkoli způsobem.


Obsah


Obecné informace

Rozhraní webových služeb pro administraci uživatelů.


Seznam poskytovaných metod

Název Popis
changePersonPassword Změna hesla uživatele.
getUserAuthenticationInfo Metoda načte informace o přihlašovacích údajích uživatele.
resetPersonPassword Nastaví výchozí systémové heslo osobě.

Seznam struktur dat

Název Popis
EosAuthenticationInfo Informace o přihlašovacích údajích uživatele.

Výjimky

EosIllegalArgumentException

Špatně zadané argumenty webové služby.

EosObjectNotFoundException

Výjimka reprezentuje stav, kdy nebyl objekt podle kriterií nalezen.

EosSecurityException

Vyjímka reprezentuje stav, kdy byl odepřen přístup kvůli nedostatečným oprávněním.

EosUnexpectedException

Reprezentuje neočekávanou výjimku při volání WS. Jejím zdrojem musí být vždy jiná výjimka.


Popis poskytovaných metod

changePersonPassword

Změna hesla uživatele.

Předpis

void changePersonPassword (String username, String currentPassword, String newPassword)

Parametry

Parametr Typ Povinný Popis
username String Ano uživatelské jméno
currentPassword String Ano aktuální heslo daného uživatele
newPassword String Ano nové heslo pro daného uživatele

Výjimky

EosSecurityException - neoprávněná změna hesla
EosUnexpectedException - vnitřní chyba systému
EosObjectNotFoundException - uživatel nebyl nalezen

getUserAuthenticationInfo

Metoda načte informace o přihlašovacích údajích uživatele.

Předpis

EosAuthenticationInfo getUserAuthenticationInfo (String userId)

Parametry

Parametr Typ Povinný Popis
userId String Ano externí identifikátor uživatele

Výstup

EosAuthenticationInfo - informace o přihlašovacích údajích uživatele

Výjimky

EosUnexpectedException - vnitřní chyba systému
EosObjectNotFoundException - uživatel nebyl nalezen

resetPersonPassword

Nastaví výchozí systémové heslo osobě.

Předpis

void resetPersonPassword (String personId)

Parametry

Parametr Typ Povinný Popis
personId String Ano ID osoby, které se nastavuje heslo

Výjimky

EosUnexpectedException - vnitřní chyba systému
EosObjectNotFoundException - uživatel nebyl nalezen
EosIllegalArgumentException - špatně zadaný parametr

Popis struktur dat

EosAuthenticationInfo

Informace o přihlašovacích údajích uživatele.

Jméno atributu Datový typ Povinné Popis
passwordExpireDate Date Ano Datum vypršení platnosti hesla uživatele.
passwordChangeRequested Boolean Ano Příznak určující nutnost změny hesla.
loginEnabled Boolean Ano Příznak určující, že se uživatel může přihlásit.