--- title: Set Logout Details node description: Configure the Set Logout Details node to add extra key-value fields to the JSON response when a journey ends with the user logging out. component: auth-node-ref version: 8.1 page_id: auth-node-ref::set-logout-details canonical_url: https://docs.pingidentity.com/auth-node-ref/latest/set-logout-details.html llms_txt: https://docs.pingidentity.com/auth-node-ref/llms.txt docs_for_agents: https://developer.pingidentity.com/build-with-ai/docs-for-agents.md revdate: 2026-08-18T00:00:00Z keywords: ["Nodes & Trees", "Journeys", "Authentication"] section_ids: examples: Examples example_1_redirect_the_user_on_logout_in_a_standalone_am_deployment: "Example 1: Redirect the user on logout in a standalone AM deployment" example_2_add_details_to_the_logout_response_in_a_ping_identity_platform_deployment: "Example 2: Add details to the logout response in a Ping Identity Platform deployment" 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. Additionally, you can use these `key:value` fields to set a `goto` parameter that redirects the user to a specified URL on logout. | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | The logout response is returned when:- a user clicks the Log Out link from the self-service profile pages in standalone AM deployments - a POST request is sent to `/json/sessions/?_action=logout` - a GET request is sent to the `/oauth2/connect/endSession` endpointIn Ping Identity Platform deployments, the 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 AM. | ## Examples ### Example 1: Redirect the user on logout in a standalone AM deployment This example uses the Set Logout Details node to redirect the user to `https://www.pingidentity.com/` when they log out. ![Example journey using the Set Logout Details node](_images/set-logout-details-journey-xui.png) * The [Page node](page.html) with the [Username Collector node](am-only/username-collector.html) and [Password Collector node](am-only/password-collector.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 redirects the user to the specified URL when they log out. This example uses the following configuration: * Logout Details * Key: `goto` * Value: `https://www.pingidentity.com/` When the user clicks the Log Out link, they're redirected to `https://www.pingidentity.com/`. | | | | - | --------------------------------------------------------------------------------------------------------------------- | | | You can view the logout response using developer tools in your browser or REST calls as described in Example 2 below. | ### Example 2: Add details to the logout response in a Ping Identity Platform deployment 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://am.example.com:8443/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 ": AQIC5w…​NTcy*" \ "https://am.example.com:8443/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`. To set the `goto` parameter for redirection, enter `goto`. 3) In the Value field, enter the details to return. For example, `true`. If you specified `goto` in the Key field, enter the URL to redirect the user to on logout. 4) Click Done. 5) Click [icon: plus, set=fa]Add to repeat and add more details. 6) Save your changes. | ## Outputs The node adds the `SetResponseDetailsLogoutHook`, which runs when the tree completes. Learn more in [Create logout hooks](https://docs.pingidentity.com/pingam/8.1/am-authentication/create-logout-hook.html). ## 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. If you set the `goto` parameter in the JSON response, the user is redirected to the specified URL after logging out. ## Errors This node doesn't log any error or warning messages of its own.