Вийти

POST 
http://localhost/api/v2/auth/logout

Неаутентифікований користувач. Після цього виклику токен доступу буде недійсним, і вам знову потрібно буде автентифікуватися для використання API Butler Smart Home.

Request

application/json

Body

object

Responses

200

Ви успішно вийшли.

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

resultstringrequired

Результат деаутентифікації

Possible values: [ok]

Example (from schema)

{
  "success": true,
  "result": "ok"
}

401

Не аутентифіковано

application/json

Schema

Schema

successbooleanrequired

Прапорець, який показує, чи був запит успішним

errorCodeintegerrequired

Ціле число помилки, див. Помилки

errorMessagestringrequired

Опис помилки

errorParameters

Додаткові дані, що описують помилку

Example (from schema)

{
  "success": true,
  "errorCode": 0,
  "errorMessage": "string"
}

Authorization: http

name: Tokentype: httpscheme: bearerdescription: Для використання цього методу користувач має отримати токен за допомогою виклику `POST /api/v2/auth/login` з використанням [Базової Аутентифікації](#section/Authentication/Basic-Authentication)

У разі успішного відгуку відповідь буде містити токен (див. [посилання](#tag/Authorization) на формат відповіді)

Кожний наступний запит повинен містити наступний заголовок:
 
```
Authorization: Bearer abcdefg1234567
```

де `abcdefg1234567` - це отриманий раніше токен.

:::note

Доступовий токен має час спливу, коли він закінчується, **Оновлювальний Токен** повинен бути використаний для отримання нового.

:::

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Post, "http://localhost/api/v2/auth/logout");
request.Headers.Add("Accept", "application/json");
request.Headers.Add("Authorization", "Bearer <token>");
var content = new StringContent("{}", null, "application/json");
request.Content = content;
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

http://localhost/api/v2

Auth

Bearer Token

Body

{}

ResponseClear

Click the Send API Request button above and see the response here!