{
  "files": [
    {
      "name": "keyapis/jwks/v1/keyapis_jwks_key_v1.proto",
      "description": "Сервис публикации публичных криптографических ключей в формате JWK",
      "package": "keyapis.jwks.v1",
      "hasEnums": false,
      "hasExtensions": false,
      "hasMessages": true,
      "hasServices": true,
      "enums": [],
      "extensions": [],
      "messages": [
        {
          "name": "DeleteKeyRequest",
          "longName": "DeleteKeyRequest",
          "fullName": "keyapis.jwks.v1.DeleteKeyRequest",
          "description": "Запрос удаления публичного ключа",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "id",
              "description": "Идентификатор ключа, соответсвует kid.\n# Тип: Guid",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 1
            }
          ]
        },
        {
          "name": "DeleteKeyResponse",
          "longName": "DeleteKeyResponse",
          "fullName": "keyapis.jwks.v1.DeleteKeyResponse",
          "description": "Ответ на запрос удаления публичного ключа",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": true,
          "extensions": [],
          "fields": [
            {
              "name": "error",
              "description": "Ошибка",
              "label": "",
              "type": "Error",
              "longType": "DeleteKeyResponse.Error",
              "fullType": "keyapis.jwks.v1.DeleteKeyResponse.Error",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "type",
              "defaultValue": "",
              "number": 1
            }
          ]
        },
        {
          "name": "Error",
          "longName": "DeleteKeyResponse.Error",
          "fullName": "keyapis.jwks.v1.DeleteKeyResponse.Error",
          "description": "Ошибка запроса удаления публичного ключа",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": true,
          "extensions": [],
          "fields": [
            {
              "name": "validation",
              "description": "Ошибка валидации",
              "label": "",
              "type": "ValidationError",
              "longType": "ValidationError",
              "fullType": "keyapis.jwks.v1.ValidationError",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "reason",
              "defaultValue": "",
              "number": 1
            }
          ]
        },
        {
          "name": "GetKeyWellKnownJwksJsonRequest",
          "longName": "GetKeyWellKnownJwksJsonRequest",
          "fullName": "keyapis.jwks.v1.GetKeyWellKnownJwksJsonRequest",
          "description": "Запрос на получение публичных ключей",
          "hasExtensions": false,
          "hasFields": false,
          "hasOneofs": false,
          "extensions": [],
          "fields": []
        },
        {
          "name": "GetKeyWellKnownJwksJsonResponse",
          "longName": "GetKeyWellKnownJwksJsonResponse",
          "fullName": "keyapis.jwks.v1.GetKeyWellKnownJwksJsonResponse",
          "description": "Ответ на запрос на получение публичных ключей",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "data",
              "description": "Список ключей",
              "label": "repeated",
              "type": "PublicKey",
              "longType": "KeyInfo.PublicKey",
              "fullType": "keyapis.jwks.v1.KeyInfo.PublicKey",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "number": 1
            }
          ]
        },
        {
          "name": "KeyInfo",
          "longName": "KeyInfo",
          "fullName": "keyapis.jwks.v1.KeyInfo",
          "description": "Ключ.\n# Описание модели",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "id",
              "description": "Идентификатор ключа, соответсвует kid.\n# Тип: Guid",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 1
            },
            {
              "name": "public_key",
              "description": "Публичный ключ",
              "label": "",
              "type": "PublicKey",
              "longType": "KeyInfo.PublicKey",
              "fullType": "keyapis.jwks.v1.KeyInfo.PublicKey",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 2
            },
            {
              "name": "created_at",
              "description": "Дата создания.\n# Тип: DateTime",
              "label": "",
              "type": "Timestamp",
              "longType": "google.protobuf.Timestamp",
              "fullType": "google.protobuf.Timestamp",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "OUTPUT_ONLY"
                  ]
                }
              },
              "number": 3
            }
          ]
        },
        {
          "name": "PublicKey",
          "longName": "KeyInfo.PublicKey",
          "fullName": "keyapis.jwks.v1.KeyInfo.PublicKey",
          "description": "Публичный ключ",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "use",
              "description": "Вид использования.\n# Диапазон: 2..32",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 1
            },
            {
              "name": "kty",
              "description": "Тип ключа.\n# Диапазон: 2..32",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 2
            },
            {
              "name": "kid",
              "description": "Идентификатор.\n# Тип: Guid",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 3
            },
            {
              "name": "alg",
              "description": "Алгоритм шифрования.\n# Диапазон: 2..32",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "number": 4
            },
            {
              "name": "n",
              "description": "Параметр Modulus",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 5
            },
            {
              "name": "e",
              "description": "Параметр Exponent",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 6
            },
            {
              "name": "x5c",
              "description": "Цепочка сертификатов X.509.\n# Диапазон: 0..100",
              "label": "repeated",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "number": 7
            }
          ]
        },
        {
          "name": "SavingError",
          "longName": "KeyInfo.SavingError",
          "fullName": "keyapis.jwks.v1.KeyInfo.SavingError",
          "description": "Ошибка сохранения.\nЭти проверки выполняются при работе с базой данных и сторонними сервисами",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": true,
          "extensions": [],
          "fields": [
            {
              "name": "key_already_exists",
              "description": "Ключ с таким идентификатором уже существует",
              "label": "",
              "type": "KeyAlreadyExists",
              "longType": "KeyInfo.SavingError.KeyAlreadyExists",
              "fullType": "keyapis.jwks.v1.KeyInfo.SavingError.KeyAlreadyExists",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "reason",
              "defaultValue": "",
              "number": 1
            }
          ]
        },
        {
          "name": "KeyAlreadyExists",
          "longName": "KeyInfo.SavingError.KeyAlreadyExists",
          "fullName": "keyapis.jwks.v1.KeyInfo.SavingError.KeyAlreadyExists",
          "description": "Ключ с таким идентификатором уже существует.\nПричины:\n- В базе хранится запись с переданнм kid",
          "hasExtensions": false,
          "hasFields": false,
          "hasOneofs": false,
          "extensions": [],
          "fields": []
        },
        {
          "name": "PostKeyRequest",
          "longName": "PostKeyRequest",
          "fullName": "keyapis.jwks.v1.PostKeyRequest",
          "description": "Запрос на сохранение публичного ключа",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "data",
              "description": "Ключ",
              "label": "",
              "type": "PublicKey",
              "longType": "KeyInfo.PublicKey",
              "fullType": "keyapis.jwks.v1.KeyInfo.PublicKey",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 1
            }
          ]
        },
        {
          "name": "PostKeyResponse",
          "longName": "PostKeyResponse",
          "fullName": "keyapis.jwks.v1.PostKeyResponse",
          "description": "Ответ на запрос на сохранение публичного ключа",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": true,
          "extensions": [],
          "fields": [
            {
              "name": "error",
              "description": "Ошибка",
              "label": "",
              "type": "Error",
              "longType": "PostKeyResponse.Error",
              "fullType": "keyapis.jwks.v1.PostKeyResponse.Error",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "type",
              "defaultValue": "",
              "number": 1
            }
          ]
        },
        {
          "name": "Error",
          "longName": "PostKeyResponse.Error",
          "fullName": "keyapis.jwks.v1.PostKeyResponse.Error",
          "description": "Ошибка",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": true,
          "extensions": [],
          "fields": [
            {
              "name": "validation",
              "description": "Ошибки валидации",
              "label": "",
              "type": "ValidationError",
              "longType": "ValidationError",
              "fullType": "keyapis.jwks.v1.ValidationError",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "reason",
              "defaultValue": "",
              "number": 1
            },
            {
              "name": "saving",
              "description": "Ошибка сохранения",
              "label": "",
              "type": "SavingError",
              "longType": "KeyInfo.SavingError",
              "fullType": "keyapis.jwks.v1.KeyInfo.SavingError",
              "ismap": false,
              "isoneof": true,
              "oneofdecl": "reason",
              "defaultValue": "",
              "number": 2
            }
          ]
        },
        {
          "name": "ValidationError",
          "longName": "ValidationError",
          "fullName": "keyapis.jwks.v1.ValidationError",
          "description": "Ошибки валидации.\nЭти проверки выполняются до обращения в базу данных",
          "hasExtensions": false,
          "hasFields": true,
          "hasOneofs": false,
          "extensions": [],
          "fields": [
            {
              "name": "path",
              "description": "Путь к полю в формате наименования прото",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 1
            },
            {
              "name": "message",
              "description": "Валидационное сообщение",
              "label": "",
              "type": "string",
              "longType": "string",
              "fullType": "string",
              "ismap": false,
              "isoneof": false,
              "oneofdecl": "",
              "defaultValue": "",
              "options": {
                "google.api.field_behavior": {
                  "options": [
                    "REQUIRED"
                  ]
                }
              },
              "number": 2
            }
          ]
        }
      ],
      "services": [
        {
          "name": "KeyService",
          "longName": "KeyService",
          "fullName": "keyapis.jwks.v1.KeyService",
          "description": "Сервис JWKS",
          "methods": [
            {
              "name": "PostKey",
              "description": "Метод сохранения публичного ключа.\nИспользуется сервисом KMS.\nСценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695357.\nМетод доступен для: service",
              "requestType": "PostKeyRequest",
              "requestLongType": "PostKeyRequest",
              "requestFullType": "keyapis.jwks.v1.PostKeyRequest",
              "requestStreaming": false,
              "responseType": "PostKeyResponse",
              "responseLongType": "PostKeyResponse",
              "responseFullType": "keyapis.jwks.v1.PostKeyResponse",
              "responseStreaming": false,
              "options": {
                "google.api.http": {
                  "rules": [
                    {
                      "method": "POST",
                      "pattern": "/jwks/internal/api/v1/key",
                      "body": "*"
                    }
                  ]
                }
              }
            },
            {
              "name": "DeleteKey",
              "description": "Метод удаления публичного ключа.\nИспользуется сервисом KMS.\nМетод доступен для: service",
              "requestType": "DeleteKeyRequest",
              "requestLongType": "DeleteKeyRequest",
              "requestFullType": "keyapis.jwks.v1.DeleteKeyRequest",
              "requestStreaming": false,
              "responseType": "DeleteKeyResponse",
              "responseLongType": "DeleteKeyResponse",
              "responseFullType": "keyapis.jwks.v1.DeleteKeyResponse",
              "responseStreaming": false,
              "options": {
                "google.api.http": {
                  "rules": [
                    {
                      "method": "DELETE",
                      "pattern": "/jwks/internal/api/v1/key/{id}"
                    }
                  ]
                }
              }
            },
            {
              "name": "GetKeyWellKnownJwksJson",
              "description": "Метод получения публичных ключей.\nВозвращает три последних публичных ключа.\nИспользуется партнёрами, с помощью публичного ключа проверяется подпись в JWT, выпущенных платформой Ключ.\nСценарий использования метода: https://confluence.rt.ru/pages/viewpage.action?pageId=664695865.\nНе требует авторизации",
              "requestType": "GetKeyWellKnownJwksJsonRequest",
              "requestLongType": "GetKeyWellKnownJwksJsonRequest",
              "requestFullType": "keyapis.jwks.v1.GetKeyWellKnownJwksJsonRequest",
              "requestStreaming": false,
              "responseType": "GetKeyWellKnownJwksJsonResponse",
              "responseLongType": "GetKeyWellKnownJwksJsonResponse",
              "responseFullType": "keyapis.jwks.v1.GetKeyWellKnownJwksJsonResponse",
              "responseStreaming": false,
              "options": {
                "google.api.http": {
                  "rules": [
                    {
                      "method": "GET",
                      "pattern": "/jwks/api/v1/key/.well-known/jwks.json"
                    }
                  ]
                }
              }
            }
          ]
        }
      ],
      "syntax": "proto3"
    }
  ],
  "scalarValueTypes": [
    {
      "protoType": "double",
      "notes": "",
      "cppType": "double",
      "csType": "double",
      "goType": "float64",
      "javaType": "double",
      "phpType": "float",
      "pythonType": "float",
      "rubyType": "Float"
    },
    {
      "protoType": "float",
      "notes": "",
      "cppType": "float",
      "csType": "float",
      "goType": "float32",
      "javaType": "float",
      "phpType": "float",
      "pythonType": "float",
      "rubyType": "Float"
    },
    {
      "protoType": "int32",
      "notes": "Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.",
      "cppType": "int32",
      "csType": "int",
      "goType": "int32",
      "javaType": "int",
      "phpType": "integer",
      "pythonType": "int",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "int64",
      "notes": "Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.",
      "cppType": "int64",
      "csType": "long",
      "goType": "int64",
      "javaType": "long",
      "phpType": "integer/string",
      "pythonType": "int/long",
      "rubyType": "Bignum"
    },
    {
      "protoType": "uint32",
      "notes": "Uses variable-length encoding.",
      "cppType": "uint32",
      "csType": "uint",
      "goType": "uint32",
      "javaType": "int",
      "phpType": "integer",
      "pythonType": "int/long",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "uint64",
      "notes": "Uses variable-length encoding.",
      "cppType": "uint64",
      "csType": "ulong",
      "goType": "uint64",
      "javaType": "long",
      "phpType": "integer/string",
      "pythonType": "int/long",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "sint32",
      "notes": "Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.",
      "cppType": "int32",
      "csType": "int",
      "goType": "int32",
      "javaType": "int",
      "phpType": "integer",
      "pythonType": "int",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "sint64",
      "notes": "Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.",
      "cppType": "int64",
      "csType": "long",
      "goType": "int64",
      "javaType": "long",
      "phpType": "integer/string",
      "pythonType": "int/long",
      "rubyType": "Bignum"
    },
    {
      "protoType": "fixed32",
      "notes": "Always four bytes. More efficient than uint32 if values are often greater than 2^28.",
      "cppType": "uint32",
      "csType": "uint",
      "goType": "uint32",
      "javaType": "int",
      "phpType": "integer",
      "pythonType": "int",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "fixed64",
      "notes": "Always eight bytes. More efficient than uint64 if values are often greater than 2^56.",
      "cppType": "uint64",
      "csType": "ulong",
      "goType": "uint64",
      "javaType": "long",
      "phpType": "integer/string",
      "pythonType": "int/long",
      "rubyType": "Bignum"
    },
    {
      "protoType": "sfixed32",
      "notes": "Always four bytes.",
      "cppType": "int32",
      "csType": "int",
      "goType": "int32",
      "javaType": "int",
      "phpType": "integer",
      "pythonType": "int",
      "rubyType": "Bignum or Fixnum (as required)"
    },
    {
      "protoType": "sfixed64",
      "notes": "Always eight bytes.",
      "cppType": "int64",
      "csType": "long",
      "goType": "int64",
      "javaType": "long",
      "phpType": "integer/string",
      "pythonType": "int/long",
      "rubyType": "Bignum"
    },
    {
      "protoType": "bool",
      "notes": "",
      "cppType": "bool",
      "csType": "bool",
      "goType": "bool",
      "javaType": "boolean",
      "phpType": "boolean",
      "pythonType": "boolean",
      "rubyType": "TrueClass/FalseClass"
    },
    {
      "protoType": "string",
      "notes": "A string must always contain UTF-8 encoded or 7-bit ASCII text.",
      "cppType": "string",
      "csType": "string",
      "goType": "string",
      "javaType": "String",
      "phpType": "string",
      "pythonType": "str/unicode",
      "rubyType": "String (UTF-8)"
    },
    {
      "protoType": "bytes",
      "notes": "May contain any arbitrary sequence of bytes.",
      "cppType": "string",
      "csType": "ByteString",
      "goType": "[]byte",
      "javaType": "ByteString",
      "phpType": "string",
      "pythonType": "str",
      "rubyType": "String (ASCII-8BIT)"
    }
  ]
}