# Протокол

## Оглавление

- [keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto](#keyapis_encryption_profile_v1_keyapis_encryption_profile_encryption_profile_v1-proto)
    - [EncryptionProfileService](#keyapis-encryption_profile-v1-EncryptionProfileService)
  
    - [DeleteEncryptionProfileRequest](#keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest)
    - [DeleteEncryptionProfileResponse](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse)
    - [DeleteEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error)
    - [DeleteEncryptionProfileResponse.Error.LinkedDevicesExists](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-LinkedDevicesExists)
    - [EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile)
    - [EncryptionProfile.SavingError](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError)
    - [EncryptionProfile.SavingError.Conflict](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-Conflict)
    - [EncryptionProfile.SavingError.RangeIsTooSmall](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-RangeIsTooSmall)
    - [EncryptionProfileFilter](#keyapis-encryption_profile-v1-EncryptionProfileFilter)
    - [EncryptionProfilePaging](#keyapis-encryption_profile-v1-EncryptionProfilePaging)
    - [GetEncryptionProfileCountRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest)
    - [GetEncryptionProfileCountResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse)
    - [GetEncryptionProfileCountResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error)
    - [GetEncryptionProfileListRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileListRequest)
    - [GetEncryptionProfileListResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse)
    - [GetEncryptionProfileListResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error)
    - [GetEncryptionProfileRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileRequest)
    - [GetEncryptionProfileResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse)
    - [GetEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error)
    - [PostEncryptionProfileRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRequest)
    - [PostEncryptionProfileResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse)
    - [PostEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error)
    - [PostEncryptionProfileRestoreRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest)
    - [PostEncryptionProfileRestoreResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreResponse)
    - [ValidationError](#keyapis-encryption_profile-v1-ValidationError)
  
    - [EncryptionProfile.Type](#keyapis-encryption_profile-v1-EncryptionProfile-Type)
    - [EncryptionProfilePaging.DirectionType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType)
    - [EncryptionProfilePaging.OrderByType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType)
  


## [Схема классов](/svg/protos/key/keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto.svg)
<a href="/svg/protos/key/keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto.svg"><img src="/svg/protos/key/keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto.svg" alt="/svg/protos/key/keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto.svg" style="height:100%;"></a>




<a name="keyapis_encryption_profile_v1_keyapis_encryption_profile_encryption_profile_v1-proto"></a>

## [keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto](/protos/key/keyapis/encryption_profile/v1/keyapis_encryption_profile_encryption_profile_v1.proto)
Сервис реализует функционал управления профилями шифрования


<a name="keyapis-encryption_profile-v1-EncryptionProfileService"></a>

### EncryptionProfileService
 Сервис профилей шифрования

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfile"></a> [PostEncryptionProfile](#keyapis-encryption_profile-v1-PostEncryptionProfile) | Метод сохранения шифрования по идентификатору. Поддерживает создание и обновление. Метод доступен для: device_admin | [keyapis.encryption_profile.v1.PostEncryptionProfileRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRequest) | [keyapis.encryption_profile.v1.PostEncryptionProfileResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse) |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfile"></a> [GetEncryptionProfile](#keyapis-encryption_profile-v1-GetEncryptionProfile) | Метод получения профиля шифрования по идентификатору. Метод доступен для: admin, service, bti, device_admin | [keyapis.encryption_profile.v1.GetEncryptionProfileRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileRequest) | [keyapis.encryption_profile.v1.GetEncryptionProfileResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse) |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileList"></a> [GetEncryptionProfileList](#keyapis-encryption_profile-v1-GetEncryptionProfileList) | Метод получения списка профилей шифрования. Метод доступен для: admin, service, bti, device_admin | [keyapis.encryption_profile.v1.GetEncryptionProfileListRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileListRequest) | [keyapis.encryption_profile.v1.GetEncryptionProfileListResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse) stream |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileCount"></a> [GetEncryptionProfileCount](#keyapis-encryption_profile-v1-GetEncryptionProfileCount) | Метод получения количества профилей шифрования. Метод доступен для: admin, service, bti, device_admin | [keyapis.encryption_profile.v1.GetEncryptionProfileCountRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest) | [keyapis.encryption_profile.v1.GetEncryptionProfileCountResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse) |
| <a id="keyapis-encryption_profile-v1-DeleteEncryptionProfile"></a> [DeleteEncryptionProfile](#keyapis-encryption_profile-v1-DeleteEncryptionProfile) | Метод удаления профиля шифрования. Метод доступен для: admin, service, device_admin | [keyapis.encryption_profile.v1.DeleteEncryptionProfileRequest](#keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest) | [keyapis.encryption_profile.v1.DeleteEncryptionProfileResponse](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse) |
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileRestore"></a> [PostEncryptionProfileRestore](#keyapis-encryption_profile-v1-PostEncryptionProfileRestore) | Метод разархивации шифрования по идентификатору. Метод доступен для: admin, service, device_admin | [keyapis.encryption_profile.v1.PostEncryptionProfileRestoreRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest) | [keyapis.encryption_profile.v1.PostEncryptionProfileRestoreResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreResponse) |

 <!-- end services -->


<a name="keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest"></a>


### [DeleteEncryptionProfileRequest](#keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest)
 Запрос удаления профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest-id"></a> [id](#keyapis-encryption_profile-v1-DeleteEncryptionProfileRequest-id) | Идентификатор. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse"></a>


### [DeleteEncryptionProfileResponse](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse)
 Ответ на запрос удаления профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-error"></a> [error](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-error) | Ошибка |  optional  [keyapis.encryption_profile.v1.DeleteEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error) | <nil>|






<a name="keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error"></a>


### [DeleteEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error)
 Ошибка запроса удаления профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-linked_devices_exists"></a> [linked_devices_exists](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-linked_devices_exists) | Существуют устройства, связанные с этим профилем шифрования |  optional  [keyapis.encryption_profile.v1.DeleteEncryptionProfileResponse.Error.LinkedDevicesExists](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-LinkedDevicesExists) | <nil>|






<a name="keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-LinkedDevicesExists"></a>


### [DeleteEncryptionProfileResponse.Error.LinkedDevicesExists](#keyapis-encryption_profile-v1-DeleteEncryptionProfileResponse-Error-LinkedDevicesExists)
 Существуют устройства, связанные с этим профилем шифрования.
Следует отвязать устройства перед удалением профиля






<a name="keyapis-encryption_profile-v1-EncryptionProfile"></a>


### [EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile)
 Профиль шифрования.
# Описание модели


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-id"></a> [id](#keyapis-encryption_profile-v1-EncryptionProfile-id) | Идентификатор. # Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-name"></a> [name](#keyapis-encryption_profile-v1-EncryptionProfile-name) | Наименование. # Диапазон: 3..64 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-description"></a> [description](#keyapis-encryption_profile-v1-EncryptionProfile-description) | Описание. # Диапазон: 3..1000 |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-type"></a> [type](#keyapis-encryption_profile-v1-EncryptionProfile-type) | Тип профиля шифрования |    [keyapis.encryption_profile.v1.EncryptionProfile.Type](#keyapis-encryption_profile-v1-EncryptionProfile-Type) | REQUIRED|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-sector_number"></a> [sector_number](#keyapis-encryption_profile-v1-EncryptionProfile-sector_number) | Номер сектора. # Диапазон: 0..15 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-block_number"></a> [block_number](#keyapis-encryption_profile-v1-EncryptionProfile-block_number) | Номер блока. # Диапазон: 0..3 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-start_index"></a> [start_index](#keyapis-encryption_profile-v1-EncryptionProfile-start_index) | Индекс первого символа для секрета. # Диапазон: 0..31 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-end_index"></a> [end_index](#keyapis-encryption_profile-v1-EncryptionProfile-end_index) | Индекс последнего символа для секрета. # Диапазон: 0..31 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-secret_a"></a> [secret_a](#keyapis-encryption_profile-v1-EncryptionProfile-secret_a) | Пароль A профиля. # Диапазон: 16..32 |    [string](#scalar-types) | INPUT_ONLY|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-encrypted_secret_a"></a> [encrypted_secret_a](#keyapis-encryption_profile-v1-EncryptionProfile-encrypted_secret_a) | Зашифрованный пароль B профиля |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-secret_b"></a> [secret_b](#keyapis-encryption_profile-v1-EncryptionProfile-secret_b) | Пароль B профиля. # Диапазон: 16..32 |    [string](#scalar-types) | INPUT_ONLY|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-encrypted_secret_b"></a> [encrypted_secret_b](#keyapis-encryption_profile-v1-EncryptionProfile-encrypted_secret_b) | Зашифрованный пароль B профиля |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-created_at"></a> [created_at](#keyapis-encryption_profile-v1-EncryptionProfile-created_at) | Дата создания. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-changed_at"></a> [changed_at](#keyapis-encryption_profile-v1-EncryptionProfile-changed_at) | Дата последнего изменения. Заполняется и обновляется сервером. Заполняется при создании и изменении. Является версией объекта. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-deleted_at"></a> [deleted_at](#keyapis-encryption_profile-v1-EncryptionProfile-deleted_at) | Дата удаления. # Тип: DateTime? |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|






<a name="keyapis-encryption_profile-v1-EncryptionProfile-SavingError"></a>


### [EncryptionProfile.SavingError](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError)
 Ошибка сохранения.
Эти проверки выполняются при работе с базой данных и сторонними сервисами


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-SavingError-conflict"></a> [conflict](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-conflict) | Конфликт версий |  optional  [keyapis.encryption_profile.v1.EncryptionProfile.SavingError.Conflict](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-Conflict) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfile-SavingError-range_is_too_small"></a> [range_is_too_small](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-range_is_too_small) | Указанный диапазон не соответствует минимальному значению |  optional  [keyapis.encryption_profile.v1.EncryptionProfile.SavingError.RangeIsTooSmall](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-RangeIsTooSmall) | <nil>|






<a name="keyapis-encryption_profile-v1-EncryptionProfile-SavingError-Conflict"></a>


### [EncryptionProfile.SavingError.Conflict](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-Conflict)
 Конфликт версий.
Причины:
- В базе хранится другая версия строки, значения changed_at оличаются






<a name="keyapis-encryption_profile-v1-EncryptionProfile-SavingError-RangeIsTooSmall"></a>


### [EncryptionProfile.SavingError.RangeIsTooSmall](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError-RangeIsTooSmall)
 Указанный диапазон не соответствует минимальному значению.
Причины:
- Модуль разности между полями start_index и end_index меньше 7






<a name="keyapis-encryption_profile-v1-EncryptionProfileFilter"></a>


### [EncryptionProfileFilter](#keyapis-encryption_profile-v1-EncryptionProfileFilter)
 Фильтр по профилям шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-EncryptionProfileFilter-text"></a> [text](#keyapis-encryption_profile-v1-EncryptionProfileFilter-text) | Поиск по тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование; # - Описание |    [string](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfileFilter-types"></a> [types](#keyapis-encryption_profile-v1-EncryptionProfileFilter-types) | По типам профиля шифрования |  repeated  [keyapis.encryption_profile.v1.EncryptionProfile.Type](#keyapis-encryption_profile-v1-EncryptionProfile-Type) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfileFilter-show_deleted"></a> [show_deleted](#keyapis-encryption_profile-v1-EncryptionProfileFilter-show_deleted) | Показывать удаленные |    [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-encryption_profile-v1-EncryptionProfilePaging"></a>


### [EncryptionProfilePaging](#keyapis-encryption_profile-v1-EncryptionProfilePaging)
 Постраничный вывод


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-order_by_type"></a> [order_by_type](#keyapis-encryption_profile-v1-EncryptionProfilePaging-order_by_type) | Тип значения сортировки. Если значение не передано, то будет взято значение по умолчанию. # По умолчанию: CHANGED_AT |    [keyapis.encryption_profile.v1.EncryptionProfilePaging.OrderByType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-direction_type"></a> [direction_type](#keyapis-encryption_profile-v1-EncryptionProfilePaging-direction_type) | Тип направления сортировки. # По умолчанию: DESC |    [keyapis.encryption_profile.v1.EncryptionProfilePaging.DirectionType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-limit"></a> [limit](#keyapis-encryption_profile-v1-EncryptionProfilePaging-limit) | Количество записей на страницу. Если значение 0 (не передано), то будет взято значение по умолчанию. # Диапазон: 0..100. # По умолчанию: 20 |    [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-offset"></a> [offset](#keyapis-encryption_profile-v1-EncryptionProfilePaging-offset) | Сдвиг. # Диапазон: 0..2147483647 |    [int32](#scalar-types) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest"></a>


### [GetEncryptionProfileCountRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest)
 Запрос получения количества профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest-filter"></a> [filter](#keyapis-encryption_profile-v1-GetEncryptionProfileCountRequest-filter) | Фильтр |    [keyapis.encryption_profile.v1.EncryptionProfileFilter](#keyapis-encryption_profile-v1-EncryptionProfileFilter) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse"></a>


### [GetEncryptionProfileCountResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse)
 Ответ на запрос получения количества профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-data"></a> [data](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-data) | Всего устройтсв |  optional  [int32](#scalar-types) | <nil>|
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-error"></a> [error](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-error) | Ошибка |  optional  [keyapis.encryption_profile.v1.GetEncryptionProfileCountResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error"></a>


### [GetEncryptionProfileCountResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error)
 Ошибка запроса получения количества профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error-validation"></a> [validation](#keyapis-encryption_profile-v1-GetEncryptionProfileCountResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.encryption_profile.v1.ValidationError](#keyapis-encryption_profile-v1-ValidationError) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileListRequest"></a>


### [GetEncryptionProfileListRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileListRequest)
 Запрос на получение списка профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileListRequest-filter"></a> [filter](#keyapis-encryption_profile-v1-GetEncryptionProfileListRequest-filter) | Фильтр |    [keyapis.encryption_profile.v1.EncryptionProfileFilter](#keyapis-encryption_profile-v1-EncryptionProfileFilter) | <nil>|
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileListRequest-paging"></a> [paging](#keyapis-encryption_profile-v1-GetEncryptionProfileListRequest-paging) | Стандартный постраничный вывод |  optional  [keyapis.encryption_profile.v1.EncryptionProfilePaging](#keyapis-encryption_profile-v1-EncryptionProfilePaging) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileListResponse"></a>


### [GetEncryptionProfileListResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse)
 Ответ на получение списка профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-data"></a> [data](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-data) | Профиль шифрования |  optional  [keyapis.encryption_profile.v1.EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile) | <nil>|
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-error"></a> [error](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-error) | Ошибка |  optional  [keyapis.encryption_profile.v1.GetEncryptionProfileListResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error"></a>


### [GetEncryptionProfileListResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error)
 Ошибка запроса получения списка профилей шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error-validation"></a> [validation](#keyapis-encryption_profile-v1-GetEncryptionProfileListResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.encryption_profile.v1.ValidationError](#keyapis-encryption_profile-v1-ValidationError) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileRequest"></a>


### [GetEncryptionProfileRequest](#keyapis-encryption_profile-v1-GetEncryptionProfileRequest)
 Запрос получения профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileRequest-id"></a> [id](#keyapis-encryption_profile-v1-GetEncryptionProfileRequest-id) | Идентификатор. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileResponse"></a>


### [GetEncryptionProfileResponse](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse)
 Ответ на запрос получения профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileResponse-data"></a> [data](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-data) | Профиль шифрования |  optional  [keyapis.encryption_profile.v1.EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile) | <nil>|
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileResponse-error"></a> [error](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-error) | Ошибка |  optional  [keyapis.encryption_profile.v1.GetEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error) | <nil>|






<a name="keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error"></a>


### [GetEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error)
 Ошибка запроса получения баннера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error-validation"></a> [validation](#keyapis-encryption_profile-v1-GetEncryptionProfileResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.encryption_profile.v1.ValidationError](#keyapis-encryption_profile-v1-ValidationError) | <nil>|






<a name="keyapis-encryption_profile-v1-PostEncryptionProfileRequest"></a>


### [PostEncryptionProfileRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRequest)
 Запрос сохранения шифрования по идентификатору


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileRequest-data"></a> [data](#keyapis-encryption_profile-v1-PostEncryptionProfileRequest-data) | Профиль шифрования |    [keyapis.encryption_profile.v1.EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile) | REQUIRED|






<a name="keyapis-encryption_profile-v1-PostEncryptionProfileResponse"></a>


### [PostEncryptionProfileResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse)
 Ответ на запрос сохранения шифрования по идентификатору


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileResponse-data"></a> [data](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-data) | Профиль шифрования |  optional  [keyapis.encryption_profile.v1.EncryptionProfile](#keyapis-encryption_profile-v1-EncryptionProfile) | <nil>|
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileResponse-error"></a> [error](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-error) | Ошибка |  optional  [keyapis.encryption_profile.v1.PostEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error) | <nil>|






<a name="keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error"></a>


### [PostEncryptionProfileResponse.Error](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error)
 Ошибка запроса сохранения профиля шифрования


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error-validation"></a> [validation](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.encryption_profile.v1.ValidationError](#keyapis-encryption_profile-v1-ValidationError) | <nil>|
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error-saving"></a> [saving](#keyapis-encryption_profile-v1-PostEncryptionProfileResponse-Error-saving) | Ошибка сохранения |  optional  [keyapis.encryption_profile.v1.EncryptionProfile.SavingError](#keyapis-encryption_profile-v1-EncryptionProfile-SavingError) | <nil>|






<a name="keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest"></a>


### [PostEncryptionProfileRestoreRequest](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest)
 Запрос разархивации шифрования по идентификатору


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest-id"></a> [id](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreRequest-id) | Идентификатор. # Тип: Guid |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-encryption_profile-v1-PostEncryptionProfileRestoreResponse"></a>


### [PostEncryptionProfileRestoreResponse](#keyapis-encryption_profile-v1-PostEncryptionProfileRestoreResponse)
 Отвест на запрос разархивации шифрования по идентификатору






<a name="keyapis-encryption_profile-v1-ValidationError"></a>


### [ValidationError](#keyapis-encryption_profile-v1-ValidationError)
 Ошибки валидации.
Эти проверки выполняются до обращения в базу данных


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-encryption_profile-v1-ValidationError-path"></a> [path](#keyapis-encryption_profile-v1-ValidationError-path) | Путь к полю в формате наименования прото |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-encryption_profile-v1-ValidationError-message"></a> [message](#keyapis-encryption_profile-v1-ValidationError-message) | Валидационное сообщение |    [string](#scalar-types) | REQUIRED|





 <!-- end messages -->



<a name="keyapis-encryption_profile-v1-EncryptionProfile-Type"></a>

### [EncryptionProfile.Type](#keyapis-encryption_profile-v1-EncryptionProfile-Type)
 Справочник типов профиля шифрования.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-encryption_profile-v1-EncryptionProfile-Type-TYPE_UNKNOWN"></a> [TYPE_UNKNOWN](#keyapis-encryption_profile-v1-EncryptionProfile-Type-TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-encryption_profile-v1-EncryptionProfile-Type-SL3"></a> [SL3](#keyapis-encryption_profile-v1-EncryptionProfile-Type-SL3) | Тип SL3 |




<a name="keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType"></a>

### [EncryptionProfilePaging.DirectionType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType)
 Справочник типов направлений сортировки;
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-DIRECTION_TYPE_UNKNOWN"></a> [DIRECTION_TYPE_UNKNOWN](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-DIRECTION_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-DESC"></a> [DESC](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-DESC) | От большего к меньшему |
| 2 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-ASC"></a> [ASC](#keyapis-encryption_profile-v1-EncryptionProfilePaging-DirectionType-ASC) | От меньшего к большему |




<a name="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType"></a>

### [EncryptionProfilePaging.OrderByType](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType)
 Справочник типов значений сортировки.
# Тип: byte

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-ID"></a> [ID](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-ID) | По идентификатору |
| 2 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-CHANGED_AT) | Дата последнего изменения |
| 3 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-CREATED_AT) | Дата создания |
| 4 | <a id="keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-RANK"></a> [RANK](#keyapis-encryption_profile-v1-EncryptionProfilePaging-OrderByType-RANK) | По рангу для поиска по тексту. Применяется когда передано поле для поиска по тексту. В случае если текстовое поле не передано, применяется значение по умолчанию |


 <!-- end enums -->

 <!-- end HasExtensions -->



## Скалярные типы значений
<a id="scalar-types"></a>

| .proto Type | Примечание | Python | Go | Ruby | C# | C++ | Java | PHP |
| ----------- | ---------- | ------ | -- | ---- | -- | --- | ---- | --- |
| [double](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float64 | Float | double | double | double | float |
| [float](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | float | float32 | Float | float | float | float | float |
| [int32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [int64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [uint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [uint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. | int/long | uint64 | Bignum or Fixnum (as required) | ulong | uint64 | long | integer/string |
| [sint32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sint64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [fixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | int | uint32 | Bignum or Fixnum (as required) | uint | uint32 | int | integer |
| [fixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | int/long | uint64 | Bignum | ulong | uint64 | long | integer/string |
| [sfixed32](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always four bytes. | int | int32 | Bignum or Fixnum (as required) | int | int32 | int | integer |
| [sfixed64](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | Always eight bytes. | int/long | int64 | Bignum | long | int64 | long | integer/string |
| [bool](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) |  | boolean | bool | TrueClass/FalseClass | bool | bool | boolean | boolean |
| [string](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | A string must always contain UTF-8 encoded or 7-bit ASCII text. | str/unicode | string | String (UTF-8) | string | string | String | string |
| [bytes](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | May contain any arbitrary sequence of bytes. | str | []byte | String (ASCII-8BIT) | ByteString | string | ByteString | string |