Flush All Active JWT Tokens

This API call forcefully invalidates all active JWT authentication and refresh tokens for a given application. All users will be required to log in again.

Warning: Use this action cautiously, as it immediately logs out all active users.

Endpoint

DELETE /root/{app_id}/flush

Headers

Name Type Required Description
Authorization string Yes The root-key of the project.

Example Request

curl --request DELETE \
--url http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush \
--header 'Authorization: {{root-key}}'
const request = require('request');

const options = {
    method: 'DELETE',
    url: 'http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush',
    headers: {Authorization: '{{root-key}}'}
};

request(options, function (error, response, body) {
    if (error) throw new Error(error);

    console.log(body);
});
import requests

url = "http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush"

headers = {"Authorization": "{{root-key}}"}

response = requests.delete(url, headers=headers)

print(response.json())
<?php
$client = new \GuzzleHttp\Client();

$response = $client->request('DELETE', 'http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush', [
    'headers' => [
    'Authorization' => '{{root-key}}',
    ],
]);

echo $response->getBody();
package main

import (
    "fmt"
    "net/http"
    "io"
)

func main() {

    url := "http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush"

    req, _ := http.NewRequest("DELETE", url, nil)

    req.Header.Add("Authorization", "{{root-key}}")

    res, _ := http.DefaultClient.Do(req)

    defer res.Body.Close()
    body, _ := io.ReadAll(res.Body)

    fmt.Println(res)
    fmt.Println(string(body))

}
AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("DELETE", "http://{{you-endpoint}}:{{your-port}}/root/{{app-id}}/flush")
    .setHeader("Authorization", "{{root-key}}")
    .execute()
    .toCompletableFuture()
    .thenAccept(System.out::println)
    .join();

client.close();

Example Success Response

{
"status": "ok"
}

Response Fields

Field Type Description
status string Indicates whether the call was successful.

Responses

Status Code Description
200 Ok Success
400 Bad Request Mostly when the form validation fails. The error will be returned as a response.
403 Access Denied When the provided root key in Authorization header is invalid.
500 Internal Server Error Mostly because of the database error. Check the log for root cause.