Identity Cloud

Debug Identity Cloud end-user journeys

Overview

You can debug your end-user journeys in your development environment, as you create them. By setting a journey to debug mode, you can view information stored in shared, transient, and secure state, as you navigate the journey. This lets you confirm that information is being passed correctly from node to node in the journey.

You need to save a journey after you activate or deactivate its debug mode setting.
Use debug mode only in your development environment.
Ensure that you have deactivated debug mode for all journeys before promoting to your staging environment. Journeys that are in debug mode are clearly marked with a Debug label in the journey list view.

Enabling debug mode temporarily inserts debug nodes between each node in the journey. This can sometimes cause problems with the behavior of a journey if an existing node expects to access node information in a specific state, because debug nodes can change the state of node information.

For example, if one journey node adds a password to secure state, and the next debug node reads that password from secure state, the password will move to transient state. Then, if the next node in the tree is expecting that password to be in secure state, and tries to read it from there, it will cause an error.

Enable debug mode

Enable debug mode to log debug information as you navigate a journey.

  1. In the Identity Cloud admin UI, click Journeys to view the journey list.

  2. (Optional) To refine the journey list, click a journey category.

  3. Find the journey you want to debug, then click it to open the journey editor.

  4. In the journey editor, click the debug button idcloudui journeys buttons debug (located on the right-hand side of the top toolbar). This will open the Debug panel.

  5. In the Debug panel, enable the Debug mode switch.

  6. Check Enable Debug Popup.

    This will automatically open and display any debug log output in a separate pop-up window, as you navigate the journey. See View debug information in a pop-up window.
  7. Click Save.

View debug information in a pop-up window

View debug log output in a separate pop-up window, as you navigate a journey.

  1. In the Identity Cloud admin UI:

    1. Follow the steps above to enable debug mode.

    2. Still in the journey editor, copy the end-user journey URL from the Preview URL field (located on the right-hand side, above the top toolbar).

  2. In a new incognito browser window (or a separate browser):

    1. Open the end-user journey URL that you copied in step 1b.

    2. The browser window will display an initial debug step. However, the pop-up window will initially be blocked (which is standard browser behavior).

    3. Unblock the pop-up window:

    4. Next, refresh the browser window. The pop-up window should now also appear.

    5. Arrange the windows so that they are both clearly visible.

    6. Navigate the journey in the browser window, and monitor the debug output for each step in the pop-up window.

Shared, transient, and secure state

Shared state

Used by nodes to store non-sensitive information that needs to be available during the authentication flow.

Transient state

Used by nodes to store sensitive information that Identity Cloud encrypts on round trips to the client.

Secure state

Used by nodes to store decrypted transient state.

Copyright © 2010-2022 ForgeRock, all rights reserved.