Запит використовується для отримання інформації про ключі, які містять ключовий контейнер. Ключовий контейнер може містити ключі електронного підпису, ключі шифрування чи обидва типи ключів одночасно.

Увага

Метод підтримує захищені параметри. 
Ознайомитись с описом та деталями використання захищених параметрів можливо за посиланням Створення та використання захищених параметрів.
Усі параметри JSON обʼєкту запиту можуть бути передані як захищені параметри. Якщо відкритий параметр та захищений параметр мають однакове ім'я, то буде використане значення захищеного параметра.

URL-адреса запиту

https://ccs-dev-api.cipher.kiev.ua/ccs/api/v1/ticket/{uuid}/keyStore/verifier

Метод

PUT

Параметри запиту
uuidStringІдентифікатор сесії
Налаштовувані заголовки запиту
Content-Typeapplication/json
Параметри JSON обʼєкта запиту
Імʼя
Тип
Опис
Допустимі значення

keyStorePassword

StringПароль до ключового контейнеру сесіїРядок, який представляє собою пароль для доступу до ключового контейнеру сесії. Ключовий контейнер сесії має бути раніше завантажений за допомогою спеціального запиту.
Відповідь
Код відповідіContent-typeДопустимі параметриПриклад вмісту
200application/jsonkeyAgreement
signature

503application/jsonmessage
{
   "message" : "Сервіс зберігання даних не запущено."
}
500application/jsonmessage


{
    "message" : "Помилка завантаження ключового контейнера: Невірний пароль до ключового контейнера або порушено його цілісність."
}
Параметри JSON обʼєкта відповіді
ПараметрТип данихОпис
messageStringОпис результату проведення операції
 signatureKeyUsageInfoІнформація про можливість використання ключа ЕП
 keyAgreementKeyUsageInfoІнформація про можливість використання ключа шифрування

Поля обʼєкта KeyUsageInfo

ПолеТип данихОпис
canBeUsedBooleanКлюч присутній в ключовому контейнері та немає обмежень на його застосування
messageStringЯкщо canBeUsed=false, то message містить опис причини, за якою ключ не може бути використаний.
Якщо canBeUsed=false, а message не містить значення, то вказаний ключ відсутній у ключовому контейнері.
Якщо canBeUsed=true, то message може містити попередження, наприклад, про те, що до завершення строку дії ключів залишилося меньше 14 днів, чи за наявності в контейнері раніше сформованого запиту на зміну ключів та ін.
certificateInfoCertificateInfoДані із сертифікату ключа

Поля обʼєкта CertificateInfo

ПолеТип данихОпис
ownerCertificateInfoObject*Інформація про власника
issuerCertificateInfoObject*Інформація про видавця
publicKeyCertificateInfoObject*Інформація про відкритий ключ
certificateSerialNumberObject*Серійний номер сертифікату
notBeforeObject*Початок дії
notAfterObject*Завершення дії
extensionsCertificateInfoObject*Розширення

Поля обʼєкта ownerCertificateInfo.value

ПолеТип данихОпис
ownerSurnameObject*Прізвище
ownerGivennameObject*Імʼя та по батькові
ownerFullNameObject*Повне імʼя
ownerCountryObject*Країна
ownerRegionObject*Область
ownerCityObject*Населений пункт
ownerAddressObject*Поштова адреса
ownerSerialNumberObject*Серійний номер власника
ownerPositionObject*Посада

Поля обʼєкта  issuerCertificateInfo.value

ПолеТип данихОпис
issuerOrganizationObject*Організація
issuerDepartmentObject*Підрозділ
issuerFullNameObject*Повне імʼя
issuerCountryObject*Країна
issuerRegionObject*Область
issuerCityObject*Населений пункт
issuerAddressObject*Поштова адреса
issuerSerialNumberObject*Серійний номер видавця

Поля обʼєкта  publicKeyCertificateInfo.value

ПолеТип данихОпис
publicKeyObject*Відкритий ключ
dsAlgorismObject*Алгоритм ЕП

Поля обʼєкта  signerInfo.extensionsCertificateInfo.value

ПолеТип данихОпис
personalDataObject*Персональні дані
alternativeOwnerNameObject*Альтернативне імʼя власника
subjectKeyIdObject*Ідентифікатор ключа
subjectOwnerIdObject*Ідентифікатор власника
certificateProfileObject*Профіль сертифікату
keyUsageObject*Призначення сертифікату
isTemporaryObject*Ознака стартового сертифікату
isReinforcedObject*Ознака посиленого сертифікату
isQualifiedObject*Ознака кваліфікованого сертифікату
isPrivateKeyOnQSCDObject*Ознака засобу КЕП
qscdTypeNameObject*Тип засобу КЕП
isElectronicStampObject*Ознака електронної печатки

Поля обʼєкта   extensionsCertificateInfo.value.personalData.value   

ПолеТип данихОпис
customIdObject*Зовнішній ідентифікатор
passportObject*Паспортні дані
drfouObject*Реєстраційний номер облікової картки платника податків

edrpou

Object*Код ЄДРПОУ

eddrun

Object*

Унікальний номер запиту в ЄДДР

Поля обʼєкта типу Object* 

ПолеТип данихОпис
descriptionStringОпис поля на мові, який обрано користувачем у Сервісі
value[Object, String, Boolean, Number, Array, null]Значення поля
Приклад обʼєкта JSON відповіді
{
  "keyAgreement": {
    "canBeUsed": false,
    "certificateInfo": {},
    "message": ""
  },
  "signature": {
    "canBeUsed": true,
    "certificateInfo": {
      "ownerCertificateInfo": {
        "description": "Власник",
        "value": {
          "ownerSurname": {
            "description": "Прізвище",
            "value": "Коваль"
          },
          "ownerGivenname": {
            "description": "Імя по-батькові",
            "value": "Кирило Кирилович"
          },
          "ownerFullName": {
            "description": "Повне ім'я",
            "value": "Співробітник банку"
          },
          "ownerCountry": {
            "description": "Країна",
            "value": "UA"
          },
          "ownerRegion": {
            "description": "Область",
            "value": "Харківська"
          },
          "ownerCity": {
            "description": "Місто",
            "value": "Харків"
          },
          "ownerAddress": {
            "description": "Поштова адреса",
            "value": null
          },
          "ownerSerialNumber": {
            "description": "Серійний номер власника",
            "value": "1AAAD3DEE6684A8F"
          },
          "ownerPosition": {
            "description": "Посада",
            "value": "Співробітник банку"
          },
          "ownerOrganization": {
            "description": "Організація",
            "value": "ПАТ "Кредобанк&quot"
          },
          "ownerOrganizationUnit": {
            "description": "Відділ (підрозділ)",
            "value": "Захисту інформації"
          }
        }
      },
      "issuerCertificateInfo": {
        "description": "Видавник",
        "value": {
          "issuerOrganization": {
            "description": "Організація",
            "value": "ТОВ \"Сайфер БІС\""
          },
          "issuerDepartment": {
            "description": "Підрозділ",
            "value": "Центр сертифікації ключів"
          },
          "issuerFullName": {
            "description": "Повне ім'я",
            "value": "ЦСК ТОВ \"Сайфер БІС\""
          },
          "issuerCountry": {
            "description": "Країна",
            "value": "ua"
          },
          "issuerRegion": {
            "description": "Область",
            "value": null
          },
          "issuerCity": {
            "description": "Місто",
            "value": "Київ"
          },
          "issuerAddress": {
            "description": "Поштова адреса",
            "value": null
          },
          "issuerSerialNumber": {
            "description": "Серійний номер видавця",
            "value": "UA-33349855-0002"
          }
        }
      },
      "publicKeyCertificateInfo": {
        "description": "Інформація про відкритий ключ",
        "value": {
          "publicKey": {
            "description": "Відкритий ключ",
            "value": "86 CA 20 5C 1D CA 25 8E 56 80 26 15 D6 5F 26 E9 1B 2B B5 12 D6 FE 9B B0 28 4B F2 05 D7 7E 38 57 00"
          },
          "dsAlgorism": {
            "description": "Алгоритм ЕП",
            "value": "ДСТУ 4145-2002, ПБ, little-endian"
          }
        }
      },
      "certificateSerialNumber": {
        "description": "Серійний номер сертифікату",
        "value": "B8 BF CA F0 E1 7D B9 1C"
      },
      "notBefore": {
        "description": "Початок дії",
        "value": "2018-09-11T09:22:11Z"
      },
      "notAfter": {
        "description": "Закінчення дії",
        "value": "2018-09-21T21:00:00Z"
      },
      "extensionsCertificateInfo": {
        "description": "Розширення",
        "value": {
          "personalData": {
            "description": "Персональні дані",
            "value": {
              "customId": {
                "description": "Зовнішній ідентифікатор",
                "value": "001"
              },
              "passport": {
                "description": "Паспортні дані",
                "value": "000123456"
              },
              "drfou": {
                "description": "Реєстраційний номер облікової картки платника податків",
                "value": "1234567891"
              },
              "edrpou": {
                "description": "Код ЕДПРОУ",
                "value": null
              },
              "eddrun": {
                "description": "Унікальний номер запису в ЄДДР",
                "value": "01010101010115"
              }
            }
          },
          "alternativeOwnerName": {
            "description": "Альтернативне ім'я власника",
            "value": "test@cipher.com"
          },
          "subjectKeyId": {
            "description": "Ідентифікатор ключа",
            "value": "D7 AE 17 4E B0 2B 38 68 8F D9 17 22 67 D1 5B AF 36 A2 5A 62 76 AA 44 94 86 C8 D9 42 E1 86 E8 9D"
          },
          "subjectOwnerId": {
            "description": "Ідентифікатор власника",
            "value": "1A AA D3 DE E6 68 4A 8F"
          },
          "certificateProfile": {
            "description": "Профіль сертифіката",
            "value": "3"
          },
          "keyUsage": {
            "description": "Призначення сертифіката",
            "value": "Цифровий підпис"
          },
          "isTemporary": {
            "description": "Стартовий",
            "value": "false"
          },
          "isReinforced": {
            "description": "Посилений",
            "value": "false"
          },
          "isQualified": {
            "description": "Кваліфікований",
            "value": "false"
          },
          "isPrivateKeyOnQSCD": {
            "description": "Засіб КЕП",
            "value": "false"
          },
          "qscdTypeName": {
            "description": "Тип засобу КЕП",
            "value": null
          },
          "isElectronicStamp" : {
            "description": "Електронна печатка",
            "value": "false"
          }
        }
      }
    },
    "message": "До закінчення дії ключів залишилося менше 6 днів. Зверніться на протязі 6 днів до центру реєстрації ключів для отримання нових ключів"
  }
}