Webová služba Authentication verze 4.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 ověření uživatelů.


Seznam poskytovaných metod

Název Popis
authenticateWithDomain Ověření uživatele pokud je známa jeho doména.
authenticateWithOrganizationId Ověření uživatele pokud je znám identifikátor jeho organizace.

Seznam struktur dat

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

Výjimky

EosUnexpectedException

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

EosUserAuthenticationException

Výjimka reprezentuje stav kdy nebylo možné ověřit uživatele. Nesmí se vyhazovat nikde jinde.


Popis poskytovaných metod

authenticateWithDomain

Ověření uživatele pokud je známa jeho doména.

Předpis

EosAuthenticationInfo authenticateWithDomain (String sid, String username, String password, String domain)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
username String Ano uživatelské jméno
password String Ano heslo
domain String Ne doména ve které je uživatel, pokud není předána použije se výchozí organizace

Výstup

EosAuthenticationInfo - informace o ověřeném uživateli

Výjimky

EosUserAuthenticationException - nebylo možné ověřit uživatele
EosUnexpectedException - vnitřní chyba systému

authenticateWithOrganizationId

Ověření uživatele pokud je znám identifikátor jeho organizace.

Předpis

EosAuthenticationInfo authenticateWithOrganizationId (String sid, String username, String password, String organizationId)

Parametry

Parametr Typ Povinný Popis
sid String Ne session id
username String Ano uživatelské jméno
password String Ano heslo
organizationId String Ne id organizace ve které je uživatel, pokud není předáno použije se výchozí organizace

Výstup

EosAuthenticationInfo - informace o ověřeném uživateli

Výjimky

EosUserAuthenticationException - nebylo možné ověřit uživatele
EosUnexpectedException - vnitřní chyba systému

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.
userAuthenticated boolean Ano Příznak určující, jestli byl uživatel ověřen.
personId String Ne Id přihlášené osoby.