# Webová služba DirectoryService verze 6.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

## Seznam poskytovaných metod

Název | Popis
--- | ---
addPersonToGroup | Přiřadí uživateli skupinu.
removeGroup | Smazání skupiny.
removePersonFromGroup | Odebere uživateli skupinu.
setPersonsStateToNTGroup | Tato metoda slouží k nastavení stavu osob které mají mít danou skupinu.
storeGroup | Uloží skupinu.

## Seznam struktur dat

Název | Popis
--- | ---
EosDSGroup | Skupina adresářové služby.
EosDSGroupScope | Rozsah skupiny.
EosDSGroupType | Typ skupiny.
EosPersonIds | Seznam identifikátorů osob.

## Výjimky

### EosIllegalArgumentException

Reprezentuje stav, kdy byl předán bevalidní vstupní argument do metody webové služby.

### EosInternalException

Neočekávaná výjimka při volání webových služeb.

### EosObjectNotFoundException

Objekt nebyl podle předaného id nalezen.

### EosSessionNotFoundException

Session s předaným id nebyla nalezena.

## Popis poskytovaných metod

### addPersonToGroup

Přiřadí uživateli skupinu.

#### Předpis

void addPersonToGroup (String sid, String personId, String groupId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
personId | String | Ano | identifikátor osoby
groupId | String | Ano | identifikátor skupiny

#### Výjimky

EosIllegalArgumentException - byl předán neplatný parametr
EosObjectNotFoundException - entita nebyla nalezena
EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

### removeGroup

Smazání skupiny. Jdou mazat jen skupiny které byly vytvořeny v aplikaci EOS.

#### Předpis

void removeGroup (String sid, String groupId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
groupId | String | Ano | identifikátor skupiny

#### Výjimky

EosIllegalArgumentException - byl předán neplatný parametr
EosObjectNotFoundException - entita nebyla nalezena
EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

### removePersonFromGroup

Odebere uživateli skupinu.

#### Předpis

void removePersonFromGroup (String sid, String personId, String groupId)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
personId | String | Ano | identifikátor osoby
groupId | String | Ano | identifikátor skupiny

#### Výjimky

EosIllegalArgumentException - byl předán neplatný parametr
EosObjectNotFoundException - entita nebyla nalezena
EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

### setPersonsStateToNTGroup

Tato metoda slouží k nastavení stavu osob které mají mít danou skupinu. Po dokončení metody budou mít danou skupinu přiřazenou jen předané osoby. Ostatním osobám bude odebrána.

#### Předpis

void setPersonsStateToNTGroup (String sid, String groupId, EosPersonIds personIds)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
groupId | String | Ano | identifikátor skupiny
personIds | EosPersonIds | Ne | identifikátory osob

#### Výjimky

EosIllegalArgumentException - byl předán neplatný parametr
EosObjectNotFoundException - entita nebyla nalezena
EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

### storeGroup

Uloží skupinu. Pokud má skupina vyplněno id bude se jednat o aktualizaci jinak se založí nová.

#### Předpis

String storeGroup (String sid, EosDSGroup group)

#### Parametry

Parametr | Typ | Povinný | Popis
--- | --- | --- | ---
sid | String | Ne | session id
group | EosDSGroup | Ano | skupina

#### Výstup

String - identifikátor skupiny

#### Výjimky

EosIllegalArgumentException - byl předán neplatný parametr
EosObjectNotFoundException - entita nebyla nalezena
EosSessionNotFoundException - session nebyla nalezena
EosInternalException - vniřní chyba systému

## Popis struktur dat

### EosDSGroup

Skupina adresářové služby.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
id | String | Ne |
directoryServiceName | String | Ne | Název připojení k adresářové službě.
name | String | Ne | Jméno skupiny.
description | String | Ne | Popis.
synchronize | boolean | Ne | Má se synchronizovat členství osob v této skupině?
groupType | EosDSGroupType | Ne | Typ skupiny.
groupScope | EosDSGroupScope | Ne | Rozsah skupiny.
email | String | Ne | E-mail skupiny.

### EosDSGroupScope

Rozsah skupiny.

Hodnota | Popis
--- | ---
BUILT_IN |
GLOBAL |
DOMAIN |
UNIVERSAL |

### EosDSGroupType

Typ skupiny.

Hodnota | Popis
--- | ---
DISTRIBUTION |
SECURITY |

### EosPersonIds

Seznam identifikátorů osob.

Jméno atributu | Datový typ | Povinné | Popis
--- | --- | --- | ---
personIds | List<String> | Ne |