Перейти к содержанию

Admin - Users

POST /api/v1/admin/users/

Create Organization User

Request Body:

Поле Тип Обязательное Описание
organization_id Organization Id да ID организации
email Email да Email пользователя
first_name First Name нет Имя
last_name Last Name нет Фамилия

Response 201: Successful Response

Поле Тип Обязательное Описание
user object нет Ответ с данными пользователя (unified для staff и organization)
temporary_password Temporary Password нет Временный пароль (отправлен на email)

Ошибки:

Код Описание
422 Validation Error

GET /api/v1/admin/users/

List Users

Query параметры:

Параметр Тип По умолчанию Описание
organization_id Organization Id Фильтр по ID организации
is_active Is Active Фильтр по активности
skip Skip 0
limit Limit 100

Response 200: Successful Response

array[UserListResponse]

Поле Тип Обязательное Описание
id Id нет
organization_id Organization Id нет
organization_name Organization Name нет
email Email нет
first_name First Name нет
last_name Last Name нет
full_name Full Name нет
is_active Is Active нет
must_change_password Must Change Password нет
failed_login_attempts Failed Login Attempts нет
locked_until Locked Until нет
created_at Created At нет
last_login_at Last Login At нет
can_view_monitoring Can View Monitoring нет
can_view_stats_callcenter Can View Stats Callcenter нет
can_view_stats_terminals Can View Stats Terminals нет
can_view_stats_operators Can View Stats Operators нет
can_manage_schedules Can Manage Schedules нет
can_view_billing Can View Billing нет

Ошибки:

Код Описание
422 Validation Error

GET /api/v1/admin/users/{user_id}

Get User

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
organization_id Organization Id нет
organization_name Organization Name нет
email Email нет
first_name First Name нет
last_name Last Name нет
full_name Full Name нет
is_active Is Active нет
must_change_password Must Change Password нет
failed_login_attempts Failed Login Attempts нет
locked_until Locked Until нет
created_at Created At нет
last_login_at Last Login At нет
can_view_monitoring Can View Monitoring нет
can_view_stats_callcenter Can View Stats Callcenter нет
can_view_stats_terminals Can View Stats Terminals нет
can_view_stats_operators Can View Stats Operators нет
can_manage_schedules Can Manage Schedules нет
can_view_billing Can View Billing нет

Ошибки:

Код Описание
422 Validation Error

PATCH /api/v1/admin/users/{user_id}

Update User

Path параметры:

Параметр Тип Описание
user_id User Id

Request Body:

Поле Тип Обязательное Описание
email Email нет
first_name First Name нет
last_name Last Name нет
is_active Is Active нет
can_view_monitoring Can View Monitoring нет
can_view_stats_callcenter Can View Stats Callcenter нет
can_view_stats_terminals Can View Stats Terminals нет
can_view_stats_operators Can View Stats Operators нет
can_manage_schedules Can Manage Schedules нет
can_view_billing Can View Billing нет

Response 200: Successful Response

Поле Тип Обязательное Описание
id Id нет
organization_id Organization Id нет
organization_name Organization Name нет
email Email нет
first_name First Name нет
last_name Last Name нет
full_name Full Name нет
is_active Is Active нет
must_change_password Must Change Password нет
failed_login_attempts Failed Login Attempts нет
locked_until Locked Until нет
created_at Created At нет
last_login_at Last Login At нет
can_view_monitoring Can View Monitoring нет
can_view_stats_callcenter Can View Stats Callcenter нет
can_view_stats_terminals Can View Stats Terminals нет
can_view_stats_operators Can View Stats Operators нет
can_manage_schedules Can Manage Schedules нет
can_view_billing Can View Billing нет

Ошибки:

Код Описание
422 Validation Error

DELETE /api/v1/admin/users/{user_id}

Deactivate User

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
message Message нет

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/admin/users/{user_id}/reset-password

Reset User Password

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
user object нет Ответ с данными пользователя (unified для staff и organization)
temporary_password Temporary Password нет Временный пароль (отправлен на email)

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/admin/users/{user_id}/unlock

Unlock User

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
message Message нет

Ошибки:

Код Описание
422 Validation Error

POST /api/v1/admin/users/{user_id}/activate

Activate User

Path параметры:

Параметр Тип Описание
user_id User Id

Response 200: Successful Response

Поле Тип Обязательное Описание
message Message нет

Ошибки:

Код Описание
422 Validation Error