Set Logout Details node

RAPID only

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 endpoint

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 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.

The Page node with the Platform Username node and Platform Password node prompt the user for their credentials.
The Data Store Decision node 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:

Create the example journey using the journey editor.

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

$ curl \
--request POST \
--header "Content-Type: application/json" \
--header "Accept-API-Version: resource=2.0, 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"
}

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

$ 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

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.

If this node is added to a no session journey or the noSession query parameter is used during authentication, the journey will fail.

Configuration

Property Usage

Property	Usage
Logout Details	The details to add to the JSON response when the user logs out: Click . In the Key field, enter a name to identify the details. For example, `clear_all_caches`. In the Value field, enter the details to return. For example, `true`. Click Done. Click Add to repeat and add more details. Save your changes.

Logout Details

The details to add to the JSON response when the user logs out:

Click .
In the Key field, enter a name to identify the details. For example, clear_all_caches.
In the Value field, enter the details to return. For example, true.
Click Done.
Click Add to repeat and add more details.
Save your changes.

Outputs

This node doesn’t change the shared state.

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.

Authentication nodes