# Протокол

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

- [keyapis/identity/v1/keyapis_identity_token_v1.proto](#keyapis_identity_v1_keyapis_identity_token_v1-proto)
    - [TokenService](#keyapis-identity-v1-TokenService)
  
    - [PostTokenUserRequest](#keyapis-identity-v1-PostTokenUserRequest)
    - [PostTokenUserResponse](#keyapis-identity-v1-PostTokenUserResponse)
    - [PostTokenUserResponse.Error](#keyapis-identity-v1-PostTokenUserResponse-Error)
    - [PostTokenUserResponse.Error.TokenError](#keyapis-identity-v1-PostTokenUserResponse-Error-TokenError)
    - [Token](#keyapis-identity-v1-Token)
  


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




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

## [keyapis/identity/v1/keyapis_identity_token_v1.proto](/protos/key/keyapis/identity/v1/keyapis_identity_token_v1.proto)
Сервис предоставляет возможность авторизации


<a name="keyapis-identity-v1-TokenService"></a>

### TokenService
 Сервис токенов пользователей

| Название метода | Описание | Тип запроса | Тип ответа |
| --------------- | -------- | ----------- | -----------|
| <a id="keyapis-identity-v1-PostTokenUser"></a> [PostTokenUser](#keyapis-identity-v1-PostTokenUser) | Метод получения токена по идентификатору пользователя. Метод доступен для: service | [keyapis.identity.v1.PostTokenUserRequest](#keyapis-identity-v1-PostTokenUserRequest) | [keyapis.identity.v1.PostTokenUserResponse](#keyapis-identity-v1-PostTokenUserResponse) |

 <!-- end services -->


<a name="keyapis-identity-v1-PostTokenUserRequest"></a>


### [PostTokenUserRequest](#keyapis-identity-v1-PostTokenUserRequest)
 Запрос на получение токена по идентификатору пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-identity-v1-PostTokenUserRequest-user_id"></a> [user_id](#keyapis-identity-v1-PostTokenUserRequest-user_id) | Идентификатор пользователя |    [int32](#scalar-types) | REQUIRED|






<a name="keyapis-identity-v1-PostTokenUserResponse"></a>


### [PostTokenUserResponse](#keyapis-identity-v1-PostTokenUserResponse)
 Ответ на запрос на получение токена по идентификатору пользователя


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






<a name="keyapis-identity-v1-PostTokenUserResponse-Error"></a>


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


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-identity-v1-PostTokenUserResponse-Error-token"></a> [token](#keyapis-identity-v1-PostTokenUserResponse-Error-token) | Ошибка получения токена |  optional  [keyapis.identity.v1.PostTokenUserResponse.Error.TokenError](#keyapis-identity-v1-PostTokenUserResponse-Error-TokenError) | <nil>|






<a name="keyapis-identity-v1-PostTokenUserResponse-Error-TokenError"></a>


### [PostTokenUserResponse.Error.TokenError](#keyapis-identity-v1-PostTokenUserResponse-Error-TokenError)
 Ошибка получения токена.
Причины:
- Ошибка в сервисе Household






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


### [Token](#keyapis-identity-v1-Token)
 Информация о токене доступа пользователя


| Поле | Описание | Тип | Признак |
| ---- | -------- | --- | ------- |
| <a id="keyapis-identity-v1-Token-access_token"></a> [access_token](#keyapis-identity-v1-Token-access_token) | Токен |    [string](#scalar-types) | REQUIRED|
| <a id="keyapis-identity-v1-Token-expires_in"></a> [expires_in](#keyapis-identity-v1-Token-expires_in) | Время (в секундах), через которое истечет срок действия Access Token |    [int32](#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 |