Группа методов User внешнего программного интерфейса Менеджера сервиса предназначена для управления учетной записью пользователя сервиса.
Сводка по методам
| Метод | Назначение |
|---|---|
| user/change_email | Инициировать смену адреса электронной почты пользователя |
| user/change_email_confirm | Завершить смену адреса электронной почты пользователя |
| user/change_login | Изменить логин пользователя |
| user/change_password | Изменить пароль пользователя |
| user/info | Информация о пользователе сервиса |
| user/set_name | Установить отображаемое имя пользователя |
| user/set_timezone | Установить основной часовой пояс пользователя |
user/change_email
Инициировать смену адреса электронной почты пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| Строка переменная (254) | Адрес электронной почты | dir@example.com | |
| Ответ: user (0..*) | |||
| Нет параметров | |||
user/change_email_confirm
Завершить смену адреса электронной почты пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| key | Строка переменная (36) | Код подтверждения смены адреса электронной почты | ABF7C2A7-1DF7-4646-9327-2866804B6CE2 |
| Ответ: user (0..*) | |||
| Нет параметров | |||
user/change_login
Изменить логин пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| login | Строка переменная (50) | Логин пользователя | Director |
| Ответ: user (0..*) | |||
| Нет параметров | |||
user/change_password
Изменить пароль пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| password | Строка неограниченной длины | Текущий пароль пользователя | d5vg1_7 |
| new_password | Строка неограниченной длины | Новый пароль пользователя | s-3qzy5 |
| Ответ: user (0..*) | |||
| Нет параметров | |||
user/info
Информация о пользователе сервиса
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| Ответ: user (1) | |||
| id | Строка переменная (36) | Идентификатор пользователя сервиса | c73c41bf-082f-4386-9f55-896b7f1b47b7 |
| login | Строка переменная (50) | Логин пользователя | Abramov |
| name | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
| email * | Строка переменная (254) | Адрес электронной почты | abramov@example.com |
| timezone * | Строка переменная (100) | Часовой пояс пользователя | Europe/Moscow |
| method2FA * | Строка (перечисление) | Способ дополнительной проверки доступа:
| |
user/set_name
Установить отображаемое имя пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| name | Строка переменная (150) | Полное имя пользователя | Абрамов Геннадий Сергеевич |
| Ответ: user (1) | |||
| Нет параметров | |||
user/set_timezone
Установить основной часовой пояс пользователя
| Параметр | Тип | Описание | Пример |
|---|---|---|---|
| Запрос | |||
| timezone | Строка переменная (100) | Часовой пояс пользователя | Europe/Moscow |
| Ответ: user (1) | |||
| Нет параметров | |||