# Протокол

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

- [keyapis/vc/v1/keyapis_vc_company_v1.proto](#keyapis_vc_v1_keyapis_vc_company_v1-proto)
    - [CompanyService](#keyapis-vc-v1-CompanyService)
  
    - [PostCompanyImpersonationRequest](#keyapis-vc-v1-PostCompanyImpersonationRequest)
    - [PostCompanyImpersonationResponse](#keyapis-vc-v1-PostCompanyImpersonationResponse)
    - [PostCompanyImpersonationResponse.CompanyImpersonation](#keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation)
    - [PostCompanyImpersonationResponse.Error](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error)
    - [PostCompanyImpersonationResponse.Error.OwnerNotFound](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-OwnerNotFound)
    - [PostCompanyImpersonationResponse.Error.UserServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-UserServiceError)
    - [PostCompanyImpersonationResponse.Error.VcfrontServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-VcfrontServiceError)
  


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




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

## [keyapis/vc/v1/keyapis_vc_company_v1.proto](/protos/key/keyapis/vc/v1/keyapis_vc_company_v1.proto)
Сервис управления компаниями


<a name="keyapis-vc-v1-CompanyService"></a>

### CompanyService
 Сервис управления компаниями

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-vc-v1-PostCompanyImpersonation"></a> [PostCompanyImpersonation](#keyapis-vc-v1-PostCompanyImpersonation) | Метод генерации имперсонационной ссылки для владельца компании. Возвращает одноразовую ссылку для имперсонации в сервисе inkey-front. Сценарий работы метода: https://confluence.rt.ru/pages/viewpage.action?pageId=1013775798. Метод доступен для: service, bti, admin | [keyapis.vc.v1.PostCompanyImpersonationRequest](#keyapis-vc-v1-PostCompanyImpersonationRequest) | [keyapis.vc.v1.PostCompanyImpersonationResponse](#keyapis-vc-v1-PostCompanyImpersonationResponse) |

 <!-- end services -->


<a name="keyapis-vc-v1-PostCompanyImpersonationRequest"></a>


### [PostCompanyImpersonationRequest](#keyapis-vc-v1-PostCompanyImpersonationRequest)
 Запрос генерации имперсонационной ссылки для компании


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-PostCompanyImpersonationRequest-company_id"></a> [company_id](#keyapis-vc-v1-PostCompanyImpersonationRequest-company_id) | Идентификатор компании. # Диапазон: 1..2147483647 |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse"></a>


### [PostCompanyImpersonationResponse](#keyapis-vc-v1-PostCompanyImpersonationResponse)
 Ответ на запрос генерации имперсонационной ссылки для компании


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-data"></a> [data](#keyapis-vc-v1-PostCompanyImpersonationResponse-data) | Имперсонационная ссылка |  optional  [keyapis.vc.v1.PostCompanyImpersonationResponse.CompanyImpersonation](#keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation) | <nil>|
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-error"></a> [error](#keyapis-vc-v1-PostCompanyImpersonationResponse-error) | Ошибка |  optional  [keyapis.vc.v1.PostCompanyImpersonationResponse.Error](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error) | <nil>|






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation"></a>


### [PostCompanyImpersonationResponse.CompanyImpersonation](#keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation)
 Имперсонационная ссылка


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation-url"></a> [url](#keyapis-vc-v1-PostCompanyImpersonationResponse-CompanyImpersonation-url) | Одноразовая ссылка для имперсонации |    [string](#scalar-types) | REQUIRED|






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse-Error"></a>


### [PostCompanyImpersonationResponse.Error](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error)
 Ошибка генерации имперсонационной ссылки для компании


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-validation"></a> [validation](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-validation) | Ошибка валидации |  optional  [keyapis.vc.v1.ValidationError](#keyapis-vc-v1-ValidationError) | <nil>|
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-owner_not_found"></a> [owner_not_found](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-owner_not_found) | Владелец компании не найден |  optional  [keyapis.vc.v1.PostCompanyImpersonationResponse.Error.OwnerNotFound](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-OwnerNotFound) | <nil>|
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-user_service_error"></a> [user_service_error](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-user_service_error) | Ошибка взаимодействия с сервисом User |  optional  [keyapis.vc.v1.PostCompanyImpersonationResponse.Error.UserServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-UserServiceError) | <nil>|
| <a id="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-vcfront_service_error"></a> [vcfront_service_error](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-vcfront_service_error) | Ошибка взаимодействия с сервисом vcfront |  optional  [keyapis.vc.v1.PostCompanyImpersonationResponse.Error.VcfrontServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-VcfrontServiceError) | <nil>|






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-OwnerNotFound"></a>


### [PostCompanyImpersonationResponse.Error.OwnerNotFound](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-OwnerNotFound)
 Владелец компании не найден






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-UserServiceError"></a>


### [PostCompanyImpersonationResponse.Error.UserServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-UserServiceError)
 Ошибка взаимодействия с сервисом User






<a name="keyapis-vc-v1-PostCompanyImpersonationResponse-Error-VcfrontServiceError"></a>


### [PostCompanyImpersonationResponse.Error.VcfrontServiceError](#keyapis-vc-v1-PostCompanyImpersonationResponse-Error-VcfrontServiceError)
 Ошибка взаимодействия с сервисом vcfront





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