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

DeleteAuthorizationPassword#

Метод предназначен для удаления (отключения) облачного пароля у авторизованной учетной записи MAX.

Для метода используются ограничения на частоту запросов в секунду.

Запрос#

Для удаления облачного пароля требуется выполнить запрос по адресу:

POST
{{apiUrl}}/waInstance{{idInstance}}/deleteAuthorizationPassword/{{apiTokenInstance}}

Для получения параметров запроса apiUrl, idInstance и apiTokenInstance обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр Тип Обязательный Описание
password string Да Текущий облачный пароль (2FA), который нужно отключить.
Длина ограничена значениями от 6 до 64 символов

Пример тела запроса#

Пример тела запроса:

{
    "password": "qwerty123"
}

Ответ#

Поля ответа#

Поле Тип Описание
status boolean Статус выполнения запроса
true - Успешное выполнение запроса
false - Ошибка выполнения запроса
data object Подробности выполнения запроса

Поля объекта data#

Поле Тип Описание
status string Результат удаления пароля:
success - Пароль успешно удалён
fail - Ошибка удаления пароля
reason string Причины при fail:
not_authorized — Инстанс не авторизован
password_not_set — Пароль отсутствует, удаление невозможно
invalid_password — Указан неверный пароль
attempts_exceeded — Превышено количество попыток ввода пароля
internal_error — Внутренняя ошибка при выполнении запроса

Пример тела ответа#

Успешное выполнение метода:

{
    "status": true,
    "data": {
        "status": "success",
        "reason": ""
    }
}

Указан неверный пароль:

{
    "status": false,
    "data": {
        "status": "fail",
        "reason": "invalid_password"
    }
}

Пароль не установлен:

{
    "status": false,
    "data": {
        "status": "fail",
        "reason": "password_not_set"
    }
}

Ошибки#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Код HTTP Идентификатор ошибки Описание
400 Bad Request
Validation failed
Ошибка валидации
400 Validation failed
Details: 'password' is required
Не передан обязательный параметр password
400 Validation failed
Details: 'password' length must be at least 6 characters long
Пароль содержит менее 6 символов
400 Validation failed
Details: 'password' length must be less than or equal to 64 characters long
Пароль содердит более 64 символов
500 Validation failed
Details: Internal Server Error
Возникла ошибка сервера

Примеры кода#

import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/deleteAuthorizationPassword/{{apiTokenInstance}}"

payload = {
    "password": "qwerty123"
}

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, json=payload, headers=headers)

print(response.text.encode('utf8'))
curl --location '{{apiUrl}}/waInstance{{idInstance}}/deleteAuthorizationPassword/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "password": "qwerty123"
}'
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/deleteAuthorizationPassword/")
    .append({{apiTokenInstance}});

var headers = new HttpHeaders();
headers.setContentType(MediaType.APPLICATION_JSON);

var jsonBody = "{\r\n\t\"password\": \"qwerty123\"\r\n}";

var requestEntity = new HttpEntity<>(jsonBody, headers);

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.POST, requestEntity, String.class);
System.out.println(response);
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/deleteAuthorizationPassword/")
    .append({{apiTokenInstance}});

var response = Unirest.post(requestUrl.toString())
    .header("Content-Type", "application/json")
    .body("{\r\n\t\"password\": \"qwerty123\"\r\n}")
    .asString();

System.out.println(response);