logout-user.md

Logout User

HTTP Method	URL	Requires Auth
POST	api/v1/users.logout	yes

Example Call

curl --location --request POST http://localhost:3000/api/v1/users.logout \
--header 'X-Auth-Token: myauth-token' \
--header 'X-User-Id: myuser-name'

Example Response

Success

{
    "message": "User JxemcN9PDCdfzJeZr has been logged out!",
    "success": true
}

Errors

The following error can occur upon the endpoint.

• Authorization: Requires an authentication token for the request to be made.

{% tabs %} {% tab title=" Authorization" %}

{
    "success": false,
    "error": "unauthorized"
}

{% endtab %} {% endtabs %}