Метод поиска субъектов
GET API – Поиск субъектов | |
Для УЗ с ролью «Пользователь» с использованием данного метода должно быть доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью «Оператор» или «Администратор» с использованием данного метода должно быть доступно получение данных любого субъекта подключенного eCA-CA. | |
URL – /middleware-service/api/v2/public/subjects | |
Query |
|
{ |
|
id (UUID[]), [опционально] | ID субъекта[1] |
resourceId (UUID[]), [опционально] | ID ресурсной системы |
securityGroupId (UUID[]), [опционально] | ID группы безопасности |
search (string), [опционально] | Полнотекстовый поиск (имя субъекта) |
isConnected (boolean), [опционально] | Флаг: субъект подключен к ресурсной системе |
isBlocked (boolean), [опционально] | Флаг: субъект заблокирован в ресурсной системе |
pageLimit (integer), [опционально] | Ограничение на размер выборки (пагинация) |
pageOffset (integer), [опционально] | Смещение от начала списка (пагинация) |
sortBy (string[]), [опционально] | Список полей, к которым применяется сортировка |
sortDirection (string) [опционально] | Направления сортировки (ASC;DESC) |
} |
|
Request |
|
- | |
Response |
|
ResponseEntity -> CollectionResponse -> { | Ответ JSON в HTTP-body |
id (UUID), | ID субъекта[2] |
commonName (string), | Имя субъекта |
distinguishedName (string), | Расположение субъекта в ресурсной системе |
resource: { | Ресурсная система |
id (uuid), | ID ресурсной системы |
commonName (string), | Имя ресурсной системы |
distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
}, |
|
subjectName: { | Имя субъекта |
(enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { | Поля разделенного имени субъекта |
values (string[]), | Значения компонента |
editable (boolean), | Флаг: компонент доступен для редактирования |
} |
|
}, |
|
subjectAltName: { | Альтернативное имя субъекта |
(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { | Поля альтернативного имени субъекта |
values (string[]), | Значения компонента |
editable (boolean), | Флаг: компонент доступен для редактирования |
} |
|
}, |
|
isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
modify (instant), | Время изменения (ISO 8601) |
certificatesCount (integer), | Количество действующих сертификатов у субъекта |
updated (instant), | Время обновления (ISO 8601) |
created (instant) | Время создания (ISO 8601) |
} |
|
[1] Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию.
[2] Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию.
Метод получения субъекта по идентификатору
GET API – Получение субъекта по идентификатору | |
Для УЗ с ролью «Пользователь» с использованием данного метода должно быть доступно только получение данных субъекта, связанный с данной УЗ. Для УЗ с ролью «Оператор» или «Администратор» с использованием данного метода должно быть доступно получение данных любого субъекта подключенного eCA-CA. | |
URL – /middleware-service/api/v2/public/subjects/{id} | |
Query |
|
{ |
|
id (UUID) | ID субъекта[1] |
} |
|
Request |
|
- | |
Response |
|
{ | Ответ JSON в HTTP-body |
id (UUID), | ID субъекта[2] |
commonName (string), | Имя субъекта |
distinguishedName (string), | Расположение субъекта в ресурсной системе |
resource: { | Ресурсная система |
id (uuid), | ID ресурсной системы |
commonName (string), | Имя ресурсной системы |
distinguishedName (string) | BaseDN точки подключения к ресурсной системе |
}, |
|
subjectName: { | Имя субъекта |
(enum: CN, UID, E, EMAILADDRESS, MAIL, SN, GIVENNAME, INITIALS, SURNAME, OU, O, L, ST, DC, C, UNSTRUCTUREDADDRESS, UNSTRUCTUREDNAME, POSTALCODE, BUSINESSCATEGORY, TELEPHONENUMBER, PSEUDONYM, POSTALADDRESS, STREET, NAME, T, DN, DESCRIPTION, INN, OGRN, OGRNIP, SNILS, INNLE, UNKNOWN): { | Поля разделенного имени субъекта |
values (string[]), | Значения компонента |
editable (boolean), | Флаг: компонент доступен для редактирования |
} |
|
}, |
|
subjectAltName: { | Альтернативное имя субъекта |
(enum: RFC822NAME, DNS_NAME, IPADDRESS, DIRECTORY_NAME, UNIFORM_RESOURCE_ID, REGISTERED_ID, MS_UPN, MS_GUID, KRB5PRINCIPAL, PERMANENT_IDENTIFIER, XMPP_ADDR, SRV_NAME, SUBJECT_IDENTIFICATION_METHOD, UNKNOWN): { | Поля альтернативного имени субъекта |
values (string[]), | Значения компонента |
editable (boolean), | Флаг: компонент доступен для редактирования |
} |
|
}, |
|
isConnected (boolean), | Флаг: субъект подключен к ресурсной системе |
isBlocked (boolean), | Флаг: субъект заблокирован в ресурсной системе |
modify (instant), | Время изменения (ISO 8601) |
certificatesCount (integer), | Количество действующих сертификатов у субъекта |
updated (instant), | Время обновления (ISO 8601) |
created (instant) | Время создания (ISO 8601) |
} |
|
[1] Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию.
[2] Субъекты eCA-CA и eCA-RA имеют сквозную идентификацию.