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

Marbes Consulting s.r.o.

EOS4

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
- Seznam poskytovaných metod
- Seznam struktur dat
- Výjimky
- Popis poskytovaných metod
- Popis struktur dat

## Obecné informace

Rozhraní webových služeb pro autentizaci uživatelů v doméně.

## Seznam poskytovaných metod

Název | Popis
--- | ---
authenticate | Ověření uživatele v doméně.

## Seznam struktur dat

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

## Výjimky

### EosObjectNotFoundException

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

### 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. Tato výjimka se může použít jen v UserAuthenticationByDigestWS!!! Nesmí se vyhazovat nikde jinde.

## Popis poskytovaných metod

### authenticate

Ověření uživatele v doméně.

#### Předpis

EosAuthenticationInfo authenticate (String usernameAndDomain, String password)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
usernameAndDomain | String | Ano | uživatelské jméno i s doménou ve formátu username@domain
password | String | Ano | heslo

#### Výstup

EosAuthenticationInfo - informace o přihlášení

#### Výjimky

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

## 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.