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

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

Сервер

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

Параметры

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

Методы

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

GET /customers/{principalId}/certificateCredentials

Получение списка данных о сертификатах пользователя. Если в качестве {principalId} используется @me, будет запрошен список данных о сертификатах пользователя, которым авторизован запрос

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

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

principalId

Обязателен

Идентификатор пользователя в UIDM. Если указано значение @me, будет использоваться значение principalId, извлечённое из токена доступа Тип данных string Пример sso_____3273f1ad-1811-410f-8ac9-f459312f15f6

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

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, // Дата окончания действия сертификата } ], Пример: [ { "id": "sso_____e957730b-afb6-4252-927e-b8b3bc525be2", "principalId": "sso_____d99c8e83-631c-4839-b8a3-6f03b697b957", "fingerprint": "401435131014121998203725519647418378614723170", "realm": "customer", "validFrom": "2020-01-21T12:19:36Z", "validTill": "2020-04-21T12:29:36Z", "displayName": "Customer name", "providerType": "jinn", } ]
204	Успешный ответ. У пользователя отсутствуют сертификаты
400	Некорректный запрос. Краткое описание причины будет указано в теле ответа

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

DELETE /customers/{principalId}/certificateCredentials/{certCredentialsId}

Удаление данных о сертификате пользователя по идентификатору сертификата. Если в качестве {principalId} используется @me, запрос на удаление будет выполнен от имени пользователя, которым авторизован запрос. Сертификат с заданным идентификатором должен принадлежать пользователю, указанному в запросе

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

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

principalId	Обязателен	Идентификатор пользователя в UIDM. Если указано значение @me, будет использоваться значение principalId, извлечённое из токена доступа Тип данных string Пример sso_____3273f1ad-1811-410f-8ac9-f459312f15f6
certCredentialsId	Обязателен	Идентификатор сертификата в UIDM Тип данных string Пример sso_____e957730b-afb6-4252-927e-b8b3bc525be2

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

realm

Пространство пользователей (realm) Тип данных string Значение по умолчанию customer

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

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