# Протокол

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

- [keyapis/multiapp/v1/keyapis_multiapp_partner_v1.proto](#keyapis_multiapp_v1_keyapis_multiapp_partner_v1-proto)
    - [PartnerService](#keyapis-multiapp-v1-PartnerService)
  
    - [DeletePartnerRequest](#keyapis-multiapp-v1-DeletePartnerRequest)
    - [DeletePartnerResponse](#keyapis-multiapp-v1-DeletePartnerResponse)
    - [DeletePartnerResponse.Error](#keyapis-multiapp-v1-DeletePartnerResponse-Error)
    - [DeletePartnerResponse.Error.LinkedAppExists](#keyapis-multiapp-v1-DeletePartnerResponse-Error-LinkedAppExists)
    - [GetPartnerAddressOrponRequest](#keyapis-multiapp-v1-GetPartnerAddressOrponRequest)
    - [GetPartnerAddressOrponResponse](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse)
    - [GetPartnerAddressOrponResponse.Error](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse-Error)
    - [GetPartnerAddressOrponResponse.Error.PermissionDenied](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse-Error-PermissionDenied)
    - [GetPartnerCountRequest](#keyapis-multiapp-v1-GetPartnerCountRequest)
    - [GetPartnerCountResponse](#keyapis-multiapp-v1-GetPartnerCountResponse)
    - [GetPartnerCountResponse.Error](#keyapis-multiapp-v1-GetPartnerCountResponse-Error)
    - [GetPartnerListRequest](#keyapis-multiapp-v1-GetPartnerListRequest)
    - [GetPartnerListResponse](#keyapis-multiapp-v1-GetPartnerListResponse)
    - [GetPartnerListResponse.Error](#keyapis-multiapp-v1-GetPartnerListResponse-Error)
    - [GetPartnerRequest](#keyapis-multiapp-v1-GetPartnerRequest)
    - [GetPartnerResponse](#keyapis-multiapp-v1-GetPartnerResponse)
    - [GetPartnerResponse.Error](#keyapis-multiapp-v1-GetPartnerResponse-Error)
    - [GetPartnerTokenRequest](#keyapis-multiapp-v1-GetPartnerTokenRequest)
    - [GetPartnerTokenResponse](#keyapis-multiapp-v1-GetPartnerTokenResponse)
    - [GetPartnerTokenResponse.Error](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error)
    - [GetPartnerTokenResponse.Error.CodeNotFoundOrExpiredError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-CodeNotFoundOrExpiredError)
    - [GetPartnerTokenResponse.Error.PermissionDenied](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-PermissionDenied)
    - [GetPartnerTokenResponse.Error.ResponseTypeIsNotSupported](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-ResponseTypeIsNotSupported)
    - [GetPartnerTokenResponse.Error.TokenGenerationError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-TokenGenerationError)
    - [GetPartnerTokenResponse.Error.UserNotFoundError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-UserNotFoundError)
    - [IdTokenPayload](#keyapis-multiapp-v1-IdTokenPayload)
    - [Partner](#keyapis-multiapp-v1-Partner)
    - [Partner.SavingError](#keyapis-multiapp-v1-Partner-SavingError)
    - [Partner.SavingError.ApiKeyExists](#keyapis-multiapp-v1-Partner-SavingError-ApiKeyExists)
    - [Partner.SavingError.Conflict](#keyapis-multiapp-v1-Partner-SavingError-Conflict)
    - [Partner.SavingError.PartnerIsDeleted](#keyapis-multiapp-v1-Partner-SavingError-PartnerIsDeleted)
    - [PartnerFilter](#keyapis-multiapp-v1-PartnerFilter)
    - [PartnerPaging](#keyapis-multiapp-v1-PartnerPaging)
    - [PostPartnerPublicKeyRequest](#keyapis-multiapp-v1-PostPartnerPublicKeyRequest)
    - [PostPartnerPublicKeyResponse](#keyapis-multiapp-v1-PostPartnerPublicKeyResponse)
    - [PostPartnerPublicKeyResponse.Error](#keyapis-multiapp-v1-PostPartnerPublicKeyResponse-Error)
    - [PostPartnerRequest](#keyapis-multiapp-v1-PostPartnerRequest)
    - [PostPartnerResponse](#keyapis-multiapp-v1-PostPartnerResponse)
    - [PostPartnerResponse.Error](#keyapis-multiapp-v1-PostPartnerResponse-Error)
    - [PostPartnerResponse.Error.MissingApiKeyOnCreation](#keyapis-multiapp-v1-PostPartnerResponse-Error-MissingApiKeyOnCreation)
    - [Token](#keyapis-multiapp-v1-Token)
  
    - [PartnerPaging.DirectionType](#keyapis-multiapp-v1-PartnerPaging-DirectionType)
    - [PartnerPaging.OrderByType](#keyapis-multiapp-v1-PartnerPaging-OrderByType)
  


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




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

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


<a name="keyapis-multiapp-v1-PartnerService"></a>

### PartnerService
 Сервис управления партнерами  для суперапа

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-multiapp-v1-PostPartner"></a> [PostPartner](#keyapis-multiapp-v1-PostPartner) | Метод сохранения партнера. Поддерживает создание и обновление. Сценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695525. Метод доступен для: admin, manager, service | [keyapis.multiapp.v1.PostPartnerRequest](#keyapis-multiapp-v1-PostPartnerRequest) | [keyapis.multiapp.v1.PostPartnerResponse](#keyapis-multiapp-v1-PostPartnerResponse) |
| <a id="keyapis-multiapp-v1-GetPartner"></a> [GetPartner](#keyapis-multiapp-v1-GetPartner) | Метод получения партнера. Метод доступен для: admin, manager, service, ltp_first | [keyapis.multiapp.v1.GetPartnerRequest](#keyapis-multiapp-v1-GetPartnerRequest) | [keyapis.multiapp.v1.GetPartnerResponse](#keyapis-multiapp-v1-GetPartnerResponse) |
| <a id="keyapis-multiapp-v1-GetPartnerList"></a> [GetPartnerList](#keyapis-multiapp-v1-GetPartnerList) | Метод получения списка партнеров. Метод доступен для: admin, manager, service, ltp_first | [keyapis.multiapp.v1.GetPartnerListRequest](#keyapis-multiapp-v1-GetPartnerListRequest) | [keyapis.multiapp.v1.GetPartnerListResponse](#keyapis-multiapp-v1-GetPartnerListResponse) stream |
| <a id="keyapis-multiapp-v1-GetPartnerCount"></a> [GetPartnerCount](#keyapis-multiapp-v1-GetPartnerCount) | Метод получения количества партнеров. Метод доступен для: admin, manager, service, ltp_first | [keyapis.multiapp.v1.GetPartnerCountRequest](#keyapis-multiapp-v1-GetPartnerCountRequest) | [keyapis.multiapp.v1.GetPartnerCountResponse](#keyapis-multiapp-v1-GetPartnerCountResponse) |
| <a id="keyapis-multiapp-v1-GetPartnerToken"></a> [GetPartnerToken](#keyapis-multiapp-v1-GetPartnerToken) | Метод получения токена. Access токен возможно получить только для пользователей с типом master в статусе active, demo и new. Логика работы метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695865. Не требует авторизации | [keyapis.multiapp.v1.GetPartnerTokenRequest](#keyapis-multiapp-v1-GetPartnerTokenRequest) | [keyapis.multiapp.v1.GetPartnerTokenResponse](#keyapis-multiapp-v1-GetPartnerTokenResponse) |
| <a id="keyapis-multiapp-v1-PostPartnerPublicKey"></a> [PostPartnerPublicKey](#keyapis-multiapp-v1-PostPartnerPublicKey) | Метод обновления публичного ключа партнёра. Поддерживает создание и обновление. Метод доступен для: partner. Требует передачи аутентификационного ключа в заголовке X-API-KEY. Сценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695525 | [keyapis.multiapp.v1.PostPartnerPublicKeyRequest](#keyapis-multiapp-v1-PostPartnerPublicKeyRequest) | [keyapis.multiapp.v1.PostPartnerPublicKeyResponse](#keyapis-multiapp-v1-PostPartnerPublicKeyResponse) |
| <a id="keyapis-multiapp-v1-DeletePartner"></a> [DeletePartner](#keyapis-multiapp-v1-DeletePartner) | Метод удаления партнёра. Сценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=804302306. Метод доступен для: admin, manager, service | [keyapis.multiapp.v1.DeletePartnerRequest](#keyapis-multiapp-v1-DeletePartnerRequest) | [keyapis.multiapp.v1.DeletePartnerResponse](#keyapis-multiapp-v1-DeletePartnerResponse) |
| <a id="keyapis-multiapp-v1-GetPartnerAddressOrpon"></a> [GetPartnerAddressOrpon](#keyapis-multiapp-v1-GetPartnerAddressOrpon) | Метод получения адреса дома по ОРПОНу. Адресная строка должны быть в формате "{Регион}, {Город}, {Улица}, {Дом}, {Строение}". Партнер может получить адрес только по доступному ему ОРПОНу. Доступные ОРПОНы для партнера может получить через привязанные app в поле app_tags и user_tags. Метод доступен для: admin, manager, service, partner. Роль partner определяется по наличию заголовка X-API-KEY вместо Authorization | [keyapis.multiapp.v1.GetPartnerAddressOrponRequest](#keyapis-multiapp-v1-GetPartnerAddressOrponRequest) | [keyapis.multiapp.v1.GetPartnerAddressOrponResponse](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse) |

 <!-- end services -->


<a name="keyapis-multiapp-v1-DeletePartnerRequest"></a>


### [DeletePartnerRequest](#keyapis-multiapp-v1-DeletePartnerRequest)
 Запрос на удаление партнёра


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






<a name="keyapis-multiapp-v1-DeletePartnerResponse"></a>


### [DeletePartnerResponse](#keyapis-multiapp-v1-DeletePartnerResponse)
 Ответ на запрос удаления партнёра


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






<a name="keyapis-multiapp-v1-DeletePartnerResponse-Error"></a>


### [DeletePartnerResponse.Error](#keyapis-multiapp-v1-DeletePartnerResponse-Error)
 Ошибка удаления партнёра


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-DeletePartnerResponse-Error-validation"></a> [validation](#keyapis-multiapp-v1-DeletePartnerResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.multiapp.v1.ValidationError](#keyapis-multiapp-v1-ValidationError) | <nil>|
| <a id="keyapis-multiapp-v1-DeletePartnerResponse-Error-linked_app_exists"></a> [linked_app_exists](#keyapis-multiapp-v1-DeletePartnerResponse-Error-linked_app_exists) | У партнера есть хотя бы одно приложение |  optional  [keyapis.multiapp.v1.DeletePartnerResponse.Error.LinkedAppExists](#keyapis-multiapp-v1-DeletePartnerResponse-Error-LinkedAppExists) | <nil>|






<a name="keyapis-multiapp-v1-DeletePartnerResponse-Error-LinkedAppExists"></a>


### [DeletePartnerResponse.Error.LinkedAppExists](#keyapis-multiapp-v1-DeletePartnerResponse-Error-LinkedAppExists)
 У партнера есть хотя бы одно приложение






<a name="keyapis-multiapp-v1-GetPartnerAddressOrponRequest"></a>


### [GetPartnerAddressOrponRequest](#keyapis-multiapp-v1-GetPartnerAddressOrponRequest)
 Запрос получения адреса по ОРПОНу


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-GetPartnerAddressOrponRequest-orpon"></a> [orpon](#keyapis-multiapp-v1-GetPartnerAddressOrponRequest-orpon) | ОРПОН. # Диапазон: 1..9223372036854775807 |    [int64](#scalar-types) | REQUIRED|






<a name="keyapis-multiapp-v1-GetPartnerAddressOrponResponse"></a>


### [GetPartnerAddressOrponResponse](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse)
 Ответ на запрос получения адреса по ОРПОНу


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






<a name="keyapis-multiapp-v1-GetPartnerAddressOrponResponse-Error"></a>


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


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






<a name="keyapis-multiapp-v1-GetPartnerAddressOrponResponse-Error-PermissionDenied"></a>


### [GetPartnerAddressOrponResponse.Error.PermissionDenied](#keyapis-multiapp-v1-GetPartnerAddressOrponResponse-Error-PermissionDenied)
 Доступ запрещен.
Причины:
- У партнера нет разрешения на переданный ОРПОН






<a name="keyapis-multiapp-v1-GetPartnerCountRequest"></a>


### [GetPartnerCountRequest](#keyapis-multiapp-v1-GetPartnerCountRequest)
 Запрос получения количества партнеров


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






<a name="keyapis-multiapp-v1-GetPartnerCountResponse"></a>


### [GetPartnerCountResponse](#keyapis-multiapp-v1-GetPartnerCountResponse)
 Ответ на запрос получения количества партнеров


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






<a name="keyapis-multiapp-v1-GetPartnerCountResponse-Error"></a>


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


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






<a name="keyapis-multiapp-v1-GetPartnerListRequest"></a>


### [GetPartnerListRequest](#keyapis-multiapp-v1-GetPartnerListRequest)
 Запрос получения списка партнеров


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-GetPartnerListRequest-filter"></a> [filter](#keyapis-multiapp-v1-GetPartnerListRequest-filter) | Фильтр |    [keyapis.multiapp.v1.PartnerFilter](#keyapis-multiapp-v1-PartnerFilter) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerListRequest-paging"></a> [paging](#keyapis-multiapp-v1-GetPartnerListRequest-paging) | Пагинация |  optional  [keyapis.multiapp.v1.PartnerPaging](#keyapis-multiapp-v1-PartnerPaging) | <nil>|






<a name="keyapis-multiapp-v1-GetPartnerListResponse"></a>


### [GetPartnerListResponse](#keyapis-multiapp-v1-GetPartnerListResponse)
 Ответ на запрос получения списка партнеров


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






<a name="keyapis-multiapp-v1-GetPartnerListResponse-Error"></a>


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


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






<a name="keyapis-multiapp-v1-GetPartnerRequest"></a>


### [GetPartnerRequest](#keyapis-multiapp-v1-GetPartnerRequest)
 Запрос получения партнера


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






<a name="keyapis-multiapp-v1-GetPartnerResponse"></a>


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


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






<a name="keyapis-multiapp-v1-GetPartnerResponse-Error"></a>


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


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






<a name="keyapis-multiapp-v1-GetPartnerTokenRequest"></a>


### [GetPartnerTokenRequest](#keyapis-multiapp-v1-GetPartnerTokenRequest)
 Запрос получения токена


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-GetPartnerTokenRequest-code"></a> [code](#keyapis-multiapp-v1-GetPartnerTokenRequest-code) | Код. # Тип: Guid |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-GetPartnerTokenRequest-response"></a> [response](#keyapis-multiapp-v1-GetPartnerTokenRequest-response) | Тип ответа. # Допустимые значения: "id_token", "token", "id_token token" |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-GetPartnerTokenRequest-nonce"></a> [nonce](#keyapis-multiapp-v1-GetPartnerTokenRequest-nonce) | Ваучер |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse"></a>


### [GetPartnerTokenResponse](#keyapis-multiapp-v1-GetPartnerTokenResponse)
 Ответ на запрос получения токена


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






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-validation"></a> [validation](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.multiapp.v1.ValidationError](#keyapis-multiapp-v1-ValidationError) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-user_not_found"></a> [user_not_found](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-user_not_found) | Ошибка: пользователь не найден |  optional  [keyapis.multiapp.v1.GetPartnerTokenResponse.Error.UserNotFoundError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-UserNotFoundError) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-token_generation_error"></a> [token_generation_error](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-token_generation_error) | Ошибка: формирования токена |  optional  [keyapis.multiapp.v1.GetPartnerTokenResponse.Error.TokenGenerationError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-TokenGenerationError) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-code_not_found_or_expired_error"></a> [code_not_found_or_expired_error](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-code_not_found_or_expired_error) | Ошибка: некорректный код |  optional  [keyapis.multiapp.v1.GetPartnerTokenResponse.Error.CodeNotFoundOrExpiredError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-CodeNotFoundOrExpiredError) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-response_type_is_not_supported"></a> [response_type_is_not_supported](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-response_type_is_not_supported) | Переданный тип ответа не поддерживается |  optional  [keyapis.multiapp.v1.GetPartnerTokenResponse.Error.ResponseTypeIsNotSupported](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-ResponseTypeIsNotSupported) | <nil>|
| <a id="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-permission_denied"></a> [permission_denied](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-permission_denied) | Доступ запрещен |  optional  [keyapis.multiapp.v1.GetPartnerTokenResponse.Error.PermissionDenied](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-PermissionDenied) | <nil>|






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-CodeNotFoundOrExpiredError"></a>


### [GetPartnerTokenResponse.Error.CodeNotFoundOrExpiredError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-CodeNotFoundOrExpiredError)
 Некорректный код.
Причины:
- Передан неверный код;
- Превышен допустимый временной интервал между запросом на формирование кода и запросом на получение идентификационного токена






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-PermissionDenied"></a>


### [GetPartnerTokenResponse.Error.PermissionDenied](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-PermissionDenied)
 Доступ запрещен.
Причины:
- У запрашивающего приложения нет разрешения на выбранный тип ответа






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-ResponseTypeIsNotSupported"></a>


### [GetPartnerTokenResponse.Error.ResponseTypeIsNotSupported](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-ResponseTypeIsNotSupported)
 Переданный тип ответа не поддерживается






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-TokenGenerationError"></a>


### [GetPartnerTokenResponse.Error.TokenGenerationError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-TokenGenerationError)
 Ошибка формирования токена.
Причины:
- Ошибка в сервисе KMS.
- Ошибка в сервисе Identity






<a name="keyapis-multiapp-v1-GetPartnerTokenResponse-Error-UserNotFoundError"></a>


### [GetPartnerTokenResponse.Error.UserNotFoundError](#keyapis-multiapp-v1-GetPartnerTokenResponse-Error-UserNotFoundError)
 Данные пользователя для формирования идентификационного токена не найдены.
Причины:
- Пользователь с таким идентификатором отсутсвует в БД ключа;
- Ошибка взаимодействия с сервисом Домохозяйств






<a name="keyapis-multiapp-v1-IdTokenPayload"></a>


### [IdTokenPayload](#keyapis-multiapp-v1-IdTokenPayload)
 Идентификационный токен


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-IdTokenPayload-jti"></a> [jti](#keyapis-multiapp-v1-IdTokenPayload-jti) | Идентификатор токена |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-nonce"></a> [nonce](#keyapis-multiapp-v1-IdTokenPayload-nonce) | Ваучер |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-sub"></a> [sub](#keyapis-multiapp-v1-IdTokenPayload-sub) | Идентификатор пользователя, для которого выдан токен |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-role"></a> [role](#keyapis-multiapp-v1-IdTokenPayload-role) | Роль |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-phone_number"></a> [phone_number](#keyapis-multiapp-v1-IdTokenPayload-phone_number) | Номер телефона |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-email"></a> [email](#keyapis-multiapp-v1-IdTokenPayload-email) | Электронная почта |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-orpon"></a> [orpon](#keyapis-multiapp-v1-IdTokenPayload-orpon) | Идентифкатор ОРПОН |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-room"></a> [room](#keyapis-multiapp-v1-IdTokenPayload-room) | Номер квартиры |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-company_id"></a> [company_id](#keyapis-multiapp-v1-IdTokenPayload-company_id) | Идентифкатор компании |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-company_name"></a> [company_name](#keyapis-multiapp-v1-IdTokenPayload-company_name) | Наименование компании |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-IdTokenPayload-auth_time"></a> [auth_time](#keyapis-multiapp-v1-IdTokenPayload-auth_time) | Время авторизации пользователя unix timestamp |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-exp"></a> [exp](#keyapis-multiapp-v1-IdTokenPayload-exp) | Срок истечения действия токен unix timestamp |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-iss"></a> [iss](#keyapis-multiapp-v1-IdTokenPayload-iss) | Сервис, выдавший токен |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-aud"></a> [aud](#keyapis-multiapp-v1-IdTokenPayload-aud) | Url сервиса, для которого выпустили токен |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-app_id"></a> [app_id](#keyapis-multiapp-v1-IdTokenPayload-app_id) | Идентификатор приложения партнёра |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-IdTokenPayload-kladr_id"></a> [kladr_id](#keyapis-multiapp-v1-IdTokenPayload-kladr_id) | КЛАДР |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-multiapp-v1-Partner"></a>


### [Partner](#keyapis-multiapp-v1-Partner)
 Партнер.
# Описание модели


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Partner-id"></a> [id](#keyapis-multiapp-v1-Partner-id) | Идентификатор. Если не передан создаётся сервером. # Тип: Guid |    [string](#scalar-types) | <nil>|
| <a id="keyapis-multiapp-v1-Partner-name"></a> [name](#keyapis-multiapp-v1-Partner-name) | Наименование. # Диапазон: 2..256 |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-multiapp-v1-Partner-api_key"></a> [api_key](#keyapis-multiapp-v1-Partner-api_key) | API ключ. # Тип: Guid? |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | INPUT_ONLY|
| <a id="keyapis-multiapp-v1-Partner-public_key"></a> [public_key](#keyapis-multiapp-v1-Partner-public_key) | Публичный ключ |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Partner-created_at"></a> [created_at](#keyapis-multiapp-v1-Partner-created_at) | Дата создания партнера. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Partner-changed_at"></a> [changed_at](#keyapis-multiapp-v1-Partner-changed_at) | Дата обновления партнера. # Тип: DateTime |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-Partner-deleted_at"></a> [deleted_at](#keyapis-multiapp-v1-Partner-deleted_at) | Дата удаления партнера. # Тип: DateTime? |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Partner-api_key_hash"></a> [api_key_hash](#keyapis-multiapp-v1-Partner-api_key_hash) | Хэш от API ключа |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Partner-api_key_masked"></a> [api_key_masked](#keyapis-multiapp-v1-Partner-api_key_masked) | API ключ маскированный |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | OUTPUT_ONLY|






<a name="keyapis-multiapp-v1-Partner-SavingError"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Partner-SavingError-conflict"></a> [conflict](#keyapis-multiapp-v1-Partner-SavingError-conflict) | Конфликт версий |  optional  [keyapis.multiapp.v1.Partner.SavingError.Conflict](#keyapis-multiapp-v1-Partner-SavingError-Conflict) | <nil>|
| <a id="keyapis-multiapp-v1-Partner-SavingError-api_key_exists"></a> [api_key_exists](#keyapis-multiapp-v1-Partner-SavingError-api_key_exists) | API-key уже существует |  optional  [keyapis.multiapp.v1.Partner.SavingError.ApiKeyExists](#keyapis-multiapp-v1-Partner-SavingError-ApiKeyExists) | <nil>|
| <a id="keyapis-multiapp-v1-Partner-SavingError-partner_is_deleted"></a> [partner_is_deleted](#keyapis-multiapp-v1-Partner-SavingError-partner_is_deleted) | Партнёр удалён |  optional  [keyapis.multiapp.v1.Partner.SavingError.PartnerIsDeleted](#keyapis-multiapp-v1-Partner-SavingError-PartnerIsDeleted) | <nil>|






<a name="keyapis-multiapp-v1-Partner-SavingError-ApiKeyExists"></a>


### [Partner.SavingError.ApiKeyExists](#keyapis-multiapp-v1-Partner-SavingError-ApiKeyExists)
 API-key уже существует.
Может появиться только в случае создания партнера.
Причины:
- В базе уже хранится такой api_key, он должен быть уникален для каждого партнера






<a name="keyapis-multiapp-v1-Partner-SavingError-Conflict"></a>


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






<a name="keyapis-multiapp-v1-Partner-SavingError-PartnerIsDeleted"></a>


### [Partner.SavingError.PartnerIsDeleted](#keyapis-multiapp-v1-Partner-SavingError-PartnerIsDeleted)
 Партнёр удалён.
Причины:
- Переданный публичный ключ принадлежит удалённому партнеру






<a name="keyapis-multiapp-v1-PartnerFilter"></a>


### [PartnerFilter](#keyapis-multiapp-v1-PartnerFilter)
 Фильтр партнеров


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-PartnerFilter-text"></a> [text](#keyapis-multiapp-v1-PartnerFilter-text) | По тексту. Если значение не передано то поиск по нему не производится. # Диапазон: 3..64. # Поиск производится по полям: # - Наименование |    [google.protobuf.StringValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-PartnerFilter-begin_changed_at"></a> [begin_changed_at](#keyapis-multiapp-v1-PartnerFilter-begin_changed_at) | От даты обновления партнера включительно (больше или равно) |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-PartnerFilter-end_changed_at"></a> [end_changed_at](#keyapis-multiapp-v1-PartnerFilter-end_changed_at) | До даты обновления партнера (меньше) |    [google.protobuf.Timestamp](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|
| <a id="keyapis-multiapp-v1-PartnerFilter-template_ids"></a> [template_ids](#keyapis-multiapp-v1-PartnerFilter-template_ids) | По идентификаторам доступных шаблонов. # Тип: Guid |  repeated  [string](#scalar-types) | <nil>|
| <a id="keyapis-multiapp-v1-PartnerFilter-is_show_deleted"></a> [is_show_deleted](#keyapis-multiapp-v1-PartnerFilter-is_show_deleted) | Показывать удаленные |    [google.protobuf.BoolValue](https://developers.google.com/protocol-buffers/docs/reference/google.protobuf/) | <nil>|






<a name="keyapis-multiapp-v1-PartnerPaging"></a>


### [PartnerPaging](#keyapis-multiapp-v1-PartnerPaging)
 Пагинация партнеров


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






<a name="keyapis-multiapp-v1-PostPartnerPublicKeyRequest"></a>


### [PostPartnerPublicKeyRequest](#keyapis-multiapp-v1-PostPartnerPublicKeyRequest)
 Запрос сохранения публичного ключа партнера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-PostPartnerPublicKeyRequest-public_key"></a> [public_key](#keyapis-multiapp-v1-PostPartnerPublicKeyRequest-public_key) | Публичный ключ |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-multiapp-v1-PostPartnerPublicKeyResponse"></a>


### [PostPartnerPublicKeyResponse](#keyapis-multiapp-v1-PostPartnerPublicKeyResponse)
 Ответ на запрос сохранения публичного ключа партнера


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






<a name="keyapis-multiapp-v1-PostPartnerPublicKeyResponse-Error"></a>


### [PostPartnerPublicKeyResponse.Error](#keyapis-multiapp-v1-PostPartnerPublicKeyResponse-Error)
 Ошибка запроса сохранения публичного ключа партнера


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






<a name="keyapis-multiapp-v1-PostPartnerRequest"></a>


### [PostPartnerRequest](#keyapis-multiapp-v1-PostPartnerRequest)
 Запрос сохранения партнера


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-PostPartnerRequest-data"></a> [data](#keyapis-multiapp-v1-PostPartnerRequest-data) | Партнер |    [keyapis.multiapp.v1.Partner](#keyapis-multiapp-v1-Partner) | REQUIRED|






<a name="keyapis-multiapp-v1-PostPartnerResponse"></a>


### [PostPartnerResponse](#keyapis-multiapp-v1-PostPartnerResponse)
 Ответ на запрос сохранения партнера


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






<a name="keyapis-multiapp-v1-PostPartnerResponse-Error"></a>


### [PostPartnerResponse.Error](#keyapis-multiapp-v1-PostPartnerResponse-Error)
 Ошибка запроса сохранения партнера


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






<a name="keyapis-multiapp-v1-PostPartnerResponse-Error-MissingApiKeyOnCreation"></a>


### [PostPartnerResponse.Error.MissingApiKeyOnCreation](#keyapis-multiapp-v1-PostPartnerResponse-Error-MissingApiKeyOnCreation)
 Api-Key обязателен при создании партнера






<a name="keyapis-multiapp-v1-Token"></a>


### [Token](#keyapis-multiapp-v1-Token)
 Ответ на запрос токена


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-multiapp-v1-Token-id_token"></a> [id_token](#keyapis-multiapp-v1-Token-id_token) | ID токен в формате nested JWT |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Token-access_token"></a> [access_token](#keyapis-multiapp-v1-Token-access_token) | Авторизационный токен |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Token-type_of_access_token"></a> [type_of_access_token](#keyapis-multiapp-v1-Token-type_of_access_token) | Тип авторизационного токена |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Token-refresh_token"></a> [refresh_token](#keyapis-multiapp-v1-Token-refresh_token) | Токен, используемый для получения нового Access Token после истечения срока действия текущего токена доступа |    [string](#scalar-types) | OUTPUT_ONLY|
| <a id="keyapis-multiapp-v1-Token-expires_in"></a> [expires_in](#keyapis-multiapp-v1-Token-expires_in) | Время (в секундах), через которое истечет срок действия Access Token |    [int32](#scalar-types) | OUTPUT_ONLY|





 <!-- end messages -->



<a name="keyapis-multiapp-v1-PartnerPaging-DirectionType"></a>

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

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




<a name="keyapis-multiapp-v1-PartnerPaging-OrderByType"></a>

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

| Номер | Тип | Название |
| ----- | --- | -------- |
| 0 | <a id="keyapis-multiapp-v1-PartnerPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN"></a> [ORDER_BY_TYPE_UNKNOWN](#keyapis-multiapp-v1-PartnerPaging-OrderByType-ORDER_BY_TYPE_UNKNOWN) | Значение не указано |
| 1 | <a id="keyapis-multiapp-v1-PartnerPaging-OrderByType-CHANGED_AT"></a> [CHANGED_AT](#keyapis-multiapp-v1-PartnerPaging-OrderByType-CHANGED_AT) | Дата последнего изменения |
| 2 | <a id="keyapis-multiapp-v1-PartnerPaging-OrderByType-CREATED_AT"></a> [CREATED_AT](#keyapis-multiapp-v1-PartnerPaging-OrderByType-CREATED_AT) | Дата создания |
| 3 | <a id="keyapis-multiapp-v1-PartnerPaging-OrderByType-RANK"></a> [RANK](#keyapis-multiapp-v1-PartnerPaging-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 |