---
title: Set Logout Details node
description: The Set Logout Details node adds details to the JSON response when a journey ends with the user logging out. You can configure the node properties to return extra information in the form of static key:value fields.
component: auth-node-ref
version: latest
page_id: auth-node-ref::set-logout-details
canonical_url: https://docs.pingidentity.com/auth-node-ref/latest/set-logout-details.html
keywords: ["Nodes & Trees", "Journeys", "Authentication"]
superseded_by: https://docs.pingidentity.com/auth-node-ref/latest/set-logout-details.html
section_ids:
  example: Example
  availability: Availability
  inputs: Inputs
  dependencies: Dependencies
  configuration: Configuration
  outputs: Outputs
  callbacks: Callbacks
  outcomes: Outcomes
  errors: Errors
---

# Set Logout Details node

The Set Logout Details node adds details to the JSON response when a journey ends with the user logging out. You can configure the node properties to return extra information in the form of static `key:value` fields.

|   |                                                                                                                                                                                                                                                                                                                                                                             |
| - | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | The logout response is returned when:- a POST request is sent to `/json/sessions/?_action=logout`

- a GET request is sent to the `/oauth2/connect/endSession` endpointThe response from logout isn't returned to the browser in the default end user UI. However, the response is available to client applications that use REST to interact with Advanced Identity Cloud. |

## Example

This example uses the Set Logout Details node to add a `clear_all_caches:true` field to the JSON response when the user logs out. This field could be read by a client application to trigger an action such as clearing caches.

![Example journey using the Set Logout Details node](_images/set-logout-details-journey-aic.png)

* The [Page node](page.html) with the [Platform Username node](platform-username.html) and [Platform Password node](platform-password.html) prompt the user for their credentials.

* The [Data Store Decision node](data-store-decision.html) confirms the username-password credentials.

* The Set Logout Details node adds the configured details to the JSON response when the user logs out. This example uses the following configuration:

  * Logout Details

    * Key: `clear_all_caches`

    * Value: `true`

Follow these steps to try the example:

1. Create the example journey using the journey editor.

2. Authenticate a test user with the journey to get a session:

   ```bash
   $ curl \
   --request POST \
   --header 'X-OpenAM-Username: bjensen' \
   --header 'X-OpenAM-Password: Ch4ng3it!' \
   --header "Accept-API-Version: resource=2.1, protocol=1.0" \
   "https://tenant-env-fqdn/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=myJourney"
   {
       "tokenId": "AQIC5w…​NTcy*",
       "successUrl": "/am/console",
       "realm": "/alpha"
   }
   ```

3. Log the user out and observe the additional logout details are shown in the response:

   ```bash
   $ curl \
   --request POST \
   --header "Content-Type: application/json" \
   --header "Accept-API-Version: resource=3.1, protocol=1.0" \
   --header "<session-cookie-name>: AQIC5w…​NTcy*" \
   "https://tenant-env-fqdn/am/json/sessions/?_action=logout"
   {
       "result": "Successfully logged out",
       "clear_all_caches": "true"
   }
   ```

## Availability

| Product                               | Available? |
| ------------------------------------- | ---------- |
| PingOne Advanced Identity Cloud       | Yes        |
| PingAM (self-managed)                 | Yes        |
| Ping Identity Platform (self-managed) | Yes        |

## Inputs

None. This node doesn't read shared state data.

## Dependencies

Make sure the user can successfully authenticate and get a session.

This node is ignored if it's added to a no session journey or the `noSession` query parameter is used during authentication.

## Configuration

| Property       | Usage                                                                                                                                                                                                                                                                                                                                                                         |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Logout Details | The details to add to the JSON response when the user logs out:1) Click [icon: plus, set=fa].

2) In the Key field, enter a name to identify the details. For example, `clear_all_caches`.

3) In the Value field, enter the details to return. For example, `true`.

4) Click Done.

5) Click [icon: plus, set=fa]Add to repeat and add more details.

6) Save your changes. |

## Outputs

This node doesn't change the shared state.

## Callbacks

This node doesn't send any callbacks.

## Outcomes

Single outcome path: when the journey ends with the user logging out, this node adds the configured details to the JSON response.

## Errors

This node doesn't log any error or warning messages of its own.