# Протокол

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

- [keyapis/kms/v1/keyapis_kms_jwt_v1.proto](#keyapis_kms_v1_keyapis_kms_jwt_v1-proto)
    - [JwtService](#keyapis-kms-v1-JwtService)
  
    - [PostKmsJwtCreateJweRequest](#keyapis-kms-v1-PostKmsJwtCreateJweRequest)
    - [PostKmsJwtCreateJweRequest.PayloadData](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData)
    - [PostKmsJwtCreateJweRequest.PayloadData.ValuesEntry](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry)
    - [PostKmsJwtCreateJweResponse](#keyapis-kms-v1-PostKmsJwtCreateJweResponse)
    - [PostKmsJwtCreateJweResponse.Error](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error)
    - [PostKmsJwtCreateJweResponse.Error.PrivateKeyNotFound](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-PrivateKeyNotFound)
    - [ValidationError](#keyapis-kms-v1-ValidationError)
  


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




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

## [keyapis/kms/v1/keyapis_kms_jwt_v1.proto](/protos/key/keyapis/kms/v1/keyapis_kms_jwt_v1.proto)
Сервис для создания JWT, находится в DMZ зоне, непосредственно не участвует в сценариях Партнёра


<a name="keyapis-kms-v1-JwtService"></a>

### JwtService
 Сервис JWT

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-kms-v1-PostKmsJwtCreateJwe"></a> [PostKmsJwtCreateJwe](#keyapis-kms-v1-PostKmsJwtCreateJwe) | Метод создание nested JWT токена. Создаёт JWT токен с клеймами переданными в PayloadData, подписывает последним выпущенным приватным ключом платформы Ключ. Токен шифруетется (JWE) публичным ключом, переданным в параметре public_key (обычно это публичный ключ партнёра). Логика работы метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695865. Метод доступен для: service | [keyapis.kms.v1.PostKmsJwtCreateJweRequest](#keyapis-kms-v1-PostKmsJwtCreateJweRequest) | [keyapis.kms.v1.PostKmsJwtCreateJweResponse](#keyapis-kms-v1-PostKmsJwtCreateJweResponse) |

 <!-- end services -->


<a name="keyapis-kms-v1-PostKmsJwtCreateJweRequest"></a>


### [PostKmsJwtCreateJweRequest](#keyapis-kms-v1-PostKmsJwtCreateJweRequest)
 Запрос на создание nested JWT токена


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweRequest-data"></a> [data](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-data) | Claims (данные включаемые в тело токена) |    [keyapis.kms.v1.PostKmsJwtCreateJweRequest.PayloadData](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData) | REQUIRED|
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweRequest-public_key"></a> [public_key](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-public_key) | Публичный ключ для шифрования |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData"></a>


### [PostKmsJwtCreateJweRequest.PayloadData](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData)
 Claims (данные включаемые в тело токена)


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-values"></a> [values](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-values) | Словарь значений. Ключи и значения являются строками. # Диапазон: 1..128 |  repeated  [keyapis.kms.v1.PostKmsJwtCreateJweRequest.PayloadData.ValuesEntry](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry) | <nil>|






<a name="keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry"></a>


### [PostKmsJwtCreateJweRequest.PayloadData.ValuesEntry](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry)
 


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry-key"></a> [key](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry-key) |  |    [string](#scalar-types) | <nil>|
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry-value"></a> [value](#keyapis-kms-v1-PostKmsJwtCreateJweRequest-PayloadData-ValuesEntry-value) |  |    [string](#scalar-types) | <nil>|






<a name="keyapis-kms-v1-PostKmsJwtCreateJweResponse"></a>


### [PostKmsJwtCreateJweResponse](#keyapis-kms-v1-PostKmsJwtCreateJweResponse)
 Ответ на запрос на формирование токена


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweResponse-data"></a> [data](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-data) | Nested JWT токен |  optional  [string](#scalar-types) | <nil>|
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweResponse-error"></a> [error](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-error) | Ошибка |  optional  [keyapis.kms.v1.PostKmsJwtCreateJweResponse.Error](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error) | <nil>|






<a name="keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error"></a>


### [PostKmsJwtCreateJweResponse.Error](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error)
 Ошибка


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-validation"></a> [validation](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.kms.v1.ValidationError](#keyapis-kms-v1-ValidationError) | <nil>|
| <a id="keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-private_key_not_found"></a> [private_key_not_found](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-private_key_not_found) | Отсутствует ключ для подписания |  optional  [keyapis.kms.v1.PostKmsJwtCreateJweResponse.Error.PrivateKeyNotFound](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-PrivateKeyNotFound) | <nil>|






<a name="keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-PrivateKeyNotFound"></a>


### [PostKmsJwtCreateJweResponse.Error.PrivateKeyNotFound](#keyapis-kms-v1-PostKmsJwtCreateJweResponse-Error-PrivateKeyNotFound)
 Отсутствует ключ для подписания






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


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


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





 <!-- end messages -->

 <!-- 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 |