Метод поиска зарегистрированных ресурсных систем

GET API – Поиск ресурсных систем

Метод доступен администратору и оператору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/findAll_4

URL – subjects-service/api/v3/public/resources

Query

 

{


id (uuid) [опционально],

Фильтр: ID ресурсной системы

securityGroupId (uuid) [опционально],

Фильтр: ID группы безопасности

subjectId (uuid) [опционально],

Фильтр: ID субъекта

search (string),

Фильтр: полнотекстовый поиск по отображаемому имени

isConnected(boolean) [опционально],

Фильтр: подключенная ресурсная система

isDefault (boolean) [опционально],

Фильтр: ресурсная система по умолчанию

status (string) [опционально],

Фильтр: статус ресурсной системы

inQueue (boolean) [опционально],

Фильтр: ресурсная система в очереди

lastSynchronizationSuccessDate (instant) [опционально]

Фильтр: дата и время последней синхронизации

}


Request

 

-


Response

 

ResponseEntity -> CollectionResponse -> {

Ответ JSON в HTTP-body

id (UUID),

ID ресурсной системы

commonName (string),

Имя ресурсной системы

distinguishedName (string),

DN ресурсной системы

subjectsCount (int64),

Количество субъектов ресурсной системы

isConnected (boolean),

Флаг: ресурсная система подключена

isDefault (boolean),

Флаг: локальная ресурсная система

updated (instant),

Время обновления (ISO 8601)

created (instant),

Время создания (ISO 8601)

status (string),

Статус ресурсной системы

inQueue (boolean),

Флаг: ресурсная система в очереди

lastSynchronizationSuccessDate (instant)

Дата и время последней синхронизации

}


Метод получения ресурсной системы по идентификатору

GET API – Получение ресурсной системы по идентификатору

Метод доступен администратору и оператору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/findById_4

URL – subjects-service/api/v3/public/resources/{id}

Query

 

{


id (uuid) [опционально]

ID ресурсной системы

}


Request

 

-


Response

 

ResponseEntity -> CollectionResponse -> {

Ответ JSON в HTTP-body

id (UUID),

ID ресурсной системы

commonName (string),

Имя ресурсной системы

distinguishedName (string),

DN ресурсной системы

subjectsCount (int64),

Количество субъектов ресурсной системы

isConnected (boolean),

Флаг: ресурсная система подключена

isDefault (boolean),

Флаг: локальная ресурсная система

updated (instant),

Время обновления (ISO 8601)

created (instant)

Время создания (ISO 8601)

status (string),

Статус ресурсной системы

inQueue (boolean),

Флаг: ресурсная система в очереди

lastSynchronizationSuccessDate (instant)

Дата и время последней синхронизации

}


Метод полной синхронизации ресурсной системы

PUT API – Полная синхронизация РС

Метод доступен администратору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A ресурсные системы/synchronize

URL – ldap-service/api/v3/public/resources/{resourceId}/synchronize

Query

 

{


resourceId (UUID)

ID ресурсной системы

}


Request

-

Response

-

Метод поиска ID ресурсных систем

GET API – Поиск ID ресурсных систем

Метод должен быть доступен администратору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A словарь субъектов/findResources

URL – subjects-service/api/v3/public/subjects/dict/resources

Query

{


id (string[])[опционально],

Фильтр: ID субъекта

notId (string[])[опционально],

Фильтр: исключая ID субъекта

resourceId (string[])[опционально],

Фильтр: ID ресурсной системы

securityGroupId (string[])[опционально],

Фильтр: ID группы безопасности

search (string),

Фильтр: полнотекстовый поиск по имени

isConnected(boolean),

Фильтр: подключение субъекта к ресурсной системе

isBlocked(boolean)

Фильтр: блокировка субъекта в ресурсной системе

}


Request
-




Response
ResponseEntity -> CollectionResponse -> {


Ответ JSON в HTTP-body

id (UUID),

ID ресурсной системы

value (string)

Имя ресурсной системы

}


Метод поиска точек подключения

GET API – Поиск точек подключения к РС

Метод доступен администратору и оператору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/findAll_12

URL – ldap-service/api/v3/public/connection-points

Query

 

{


id (uuid) [опционально],

Фильтр: ID точки подключения

resourceId (uuid) [опционально],

Фильтр: ID ресурсной системы

search (string),

Фильтр: полнотекстовый поиск по отображаемому имени

sortDirection (string) [опционально],

Направления сортировки (ASC;DESC)

sortBy (string[])[опционально],

Список полей, к которым применяется сортировка

pageOffset (integer) [опционально],

Смещение от начала списка (пагинация)

pageLimit (integer) [опционально]

Ограничение на размер выборки (пагинация)

inQueue (boolean) [опционально]

Фильтр: точка подключения в очереди

}


Request

 

-


Response

 

ResponseEntity -> CollectionResponse -> {

Ответ JSON в HTTP-body

id (UUID),

ID точки подключения

title (string),

Имя точки подключения

domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN),

Тип точки подключения

connectionAddress (string),

Адрес (хост) подключения

useTls (boolean),

Флаг: использовать TLS при подключении

baseDn(string),

BaseDN точки подключения

username (string),

Имя пользователя ресурсной системы

status (string)

Статут точки подключения

resourceId (UUID),

ID ресурсной системы

updated (instant),

Время обновления (ISO 8601)

created (instant)

Время создания (ISO 8601)

inQueue (boolean)

Флаг: точка подключения в очереди

}


Метод получения точки подключения по идентификатору

GET API – Получение точки подключения по идентификатору

Метод доступен администратору и оператору

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/findById_11

URL – ldap-service/api/v3/public/connection-points/{id}

Query

 

{


id (uuid)

ID точки подключения

}


Request

 

-


Response

 

ResponseEntity -> CollectionResponse -> {

Ответ JSON в HTTP-body

id (UUID),

ID точки подключения

title (string),

Имя точки подключения

domainType(enum: SAMBA_DC, MS_AD, RED_ADM, FREE_IPA, ALD_PRO, ALT_DOMAIN, UNKNOWN),

Тип точки подключения

connectionAddress (string),

Адрес (хост) подключения

useTls (boolean),

Флаг: использовать TLS при подключении

baseDn(string),

BaseDN точки подключения

username (string),

Имя пользователя ресурсной системы

status (string)

Статут точки подключения

resourceId (UUID),

ID ресурсной системы

updated (instant),

Время обновления (ISO 8601)

created (instant)

Время создания (ISO 8601)

inQueue (boolean)

Флаг: точка подключения в очереди

}


Метод частичной синхронизации точки подключения

PUT API – Частичная синхронизация точки подключения

Метод доступен администратору и оператору при наличии полномочий

Swagger: https://HOST/external-integration-service/swagger/swagger-ui/index.html#/[v3] Контроллер%3A Точки подключения ресурсных систем/synchronize_1

URL – ldap-service/api/v3/public/connection-points/{pointId}/synchronize

Query

 

{


pointId (UUID)

ID точки подключения

}


Request

-

Response

-