API управления сертификатами электронной подписи от лица приложения

API управления сертификатами электронной подписи от лица приложения Версия 0.1.200220

Сервер

https://{hostname}:{port}/{context-path} — Описание отсутствует

Параметры

hostname	Описание отсутствует
port	Порт сервера Возможные значения: 80443 Значение по умолчанию: 80
context-path	Описание отсутствует Значение по умолчанию: /sso/provision

Методы

Получение списка данных о сертификатах по идентификатору пользователя

GET /certificateCredentials

Получение списка данных о сертификатах по идентификатору пользователя

Параметры запроса

Параметры, размещаемые в тексте запроса

principalId	Обязателен	Идентификатор пользователя в UIDM вида {prefix}_{id}, например sso_____3273f1ad-1811-410f-8ac9-f459312f15f6 Тип данных string
realm		Пространство пользователей (realm) Тип данных string Значение по умолчанию customer

Ответы сервера

HTTP-код	Описание
200	Успешный ответ. Список данных о сертификатах содержится в теле ответа application/json [ // Список данных о сертификатах { "displayName": string, // Отображаемое имя сертификата "fingerprint": string, // Уникальный отпечаток сертификата "id": string, // Идентификатор записи "principalId": string, // Идентификатор пользователя "providerType": string, // Краткое наименование провайдера валидации подписи сертификата "realm": string, // Пространство пользователей (realm) "validFrom": string, // Дата начала действия сертификата "validTill": string, // Дата окончания действия сертификата } ], Пример: [ { "displayName": "Customer name", "fingerprint": "401435131014121998203725519647418378614723170", "id": "sso_____e957730b-afb6-4252-927e-b8b3bc525be2", "principalId": "sso_____d99c8e83-631c-4839-b8a3-6f03b697b957", "providerType": "jinn", "realm": "customer", "validFrom": "2020-01-21T12:19:36Z", "validTill": "2020-04-21T12:29:36Z", } ]
204	Успешный ответ. У пользователя отсутствуют сертификаты
400	Некорректный запрос. Краткое описание причины будет указано в теле ответа

Получение данных сертификата по идентификатору сертификата

GET /certificateCredentials/{certCredentialsId}

Получение данных сертификата по идентификатору сертификата

Параметры запроса

Параметры, размещаемые в пути метода

certCredentialsId

Обязателен

Идентификатор сертификата в UIDM вида {prefix}_{id}, например sso_____3273f1ad-1811-410f-8ac9-f459312f15f6 Тип данных string

Ответы сервера

HTTP-код	Описание
200	Успешный ответ. Данные о сертификате содержатся в теле ответа application/json "displayName": string, // Отображаемое имя сертификата "fingerprint": string, // Уникальный отпечаток сертификата "id": string, // Идентификатор записи "principalId": string, // Идентификатор пользователя "providerType": string, // Краткое наименование провайдера валидации подписи сертификата "realm": string, // Пространство пользователей (realm) "validFrom": string, // Дата начала действия сертификата "validTill": string, // Дата окончания действия сертификата Пример: { "displayName": "Customer name", "fingerprint": "401435131014121998203725519647418378614723170", "id": "sso_____e957730b-afb6-4252-927e-b8b3bc525be2", "principalId": "sso_____d99c8e83-631c-4839-b8a3-6f03b697b957", "providerType": "jinn", "realm": "customer", "validFrom": "2020-01-21T12:19:36Z", "validTill": "2020-04-21T12:29:36Z", }
400	Некорректный запрос. Краткое описание причины будет указано в теле ответа
404	Некорректный запрос. Сертификат с заданным идентификатором не найден(-ы)

Удаление данных сертификата по идентификатору сертификата

DELETE /certificateCredentials/{certCredentialsId}

Удаление данных сертификата по идентификатору сертификата

Параметры запроса

Параметры, размещаемые в пути метода

certCredentialsId

Обязателен

Идентификатор сертификата в UIDM вида {prefix}_{id}, например sso_____3273f1ad-1811-410f-8ac9-f459312f15f6 Тип данных string

Ответы сервера

HTTP-код	Описание
204	Успешный ответ. Данные сертификата удалены
400	Некорректный запрос. Краткое описание причины будет указано в теле ответа
404	Некорректный запрос. Сертификат с заданным идентификатором не найден(-ы)