Logout

Description

This service logs out the currently authenticated party, ending their session.

---

Request

Restrictions

This service requires an authenticated user and can only be called when a consumer is logged in.

Endpoint

GET https://<server-url>/api/v3/logout

Parameters

Parameter	Location	Description
touchpoint	Query / Header	The identifier for the touchpoint. Use Thalamus-Touchpoint for the header.
token	Query / Header	The authentication token for the API. Use Thalamus-Token for the header.
activity	Query / Header	Optional. The activity to be used. Use Thalamus-Activity for the header.
Content-Type	Header	Specifies the content type of the request body. Must be application/json.

Full URL Example

https://<server-url>/api/v3/logout?touchpoint=test&token=...

Request Body

This request does not have a body.

---

Response

✅ Successful Response: 200 OK

The user has been successfully logged out. The response returns a new, unauthenticated context with links for registration and login.

JSON

{
  "context": {
    "links": [
      {
        "ref": "register",
        "href": "http://localhost:8080/thalamus/api/v3/person"
      },
      {
        "ref": "login",
        "href": "http://localhost:8080/thalamus/api/v3/thalamus_security_check"
      }
    ],
    "activities": [],
    "simpleProfile": null
  }
}