/*
  Сервис предоставляет возможность действий с пользователями
*/
syntax = "proto3";

import "google/api/annotations.proto";
import "google/api/field_behavior.proto";
import "google/protobuf/timestamp.proto";

package keyapis.identity.v1;

option java_package = "ru.keyapis.identity.v1";
option java_outer_classname = "KeyapisIdentityV1Proto";
option java_multiple_files = false;
option java_string_check_utf8 = true;
option go_package = "/keyapis_identity_v1";
option cc_enable_arenas = true;
option csharp_namespace = "Keyapis.Identity.V1";
option objc_class_prefix = "KEYAPISIDENTITYV1";
option php_namespace = "Keyapis\\Identity\\V1";
option ruby_package = "Keyapis::Identity::V1";
option optimize_for = LITE_RUNTIME;

// Сервис действий с пользователями
service UserService {
  // Метод переноса кабинета ключа в другой кабинет SSO.
  // Метод доступен для: admin, service, ltp_first
  rpc PostUserSsoMigration(PostUserSsoMigrationRequest) returns (PostUserSsoMigrationResponse) {
    option (google.api.http) = {
      post: "/identity/api/v1/user/sso_migration",
      body: "*"
    };
  }
}


// Запрос на перенос кабинета ключа
message PostUserSsoMigrationRequest {
  // Идентификатор мигрируемого пользователя.
  // # Диапазон: 1..2147483647
  int32 user_id = 1 [(google.api.field_behavior) = REQUIRED];
  // Целевой номер телефона.
  // # Диапазон: 5..14
  string phone_number = 2 [(google.api.field_behavior) = REQUIRED];
}

// Ответ на запрос на перенос кабинета ключа
message PostUserSsoMigrationResponse {
  // Ошибка запроса на перенос кабинета ключа
  message Error {
    // Номер уже используется. Укажите другой номер
    message UserExists {}
    // Причина ошибки
    oneof reason {
      // Ошибка валидации
      ValidationError validation = 1;
      // Номер уже используется. Укажите другой номер
      UserExists user_exists = 2;
    }
  }

  // Тип результата
  oneof type {
    // Ошибка
    Error error = 1;
  }
}

// Ошибки валидации.
// Эти проверки выполняются до обращения в базу данных
message ValidationError {
  // Путь к полю в формате наименования прото
  string path = 1 [(google.api.field_behavior) = REQUIRED];
  // Валидационное сообщение
  string message = 2 [(google.api.field_behavior) = REQUIRED];
}
