---
title: Set Error Details node
description: Configure the Set Error Details node to add a custom error message, extra key-value fields, and custom response headers to the JSON response when a journey ends in error.
component: auth-node-ref
version: 8
page_id: auth-node-ref::set-error-details
canonical_url: https://docs.pingidentity.com/auth-node-ref/latest/set-error-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
keywords: ["Nodes & Trees", "Journeys", "Authentication"]
superseded_by: https://docs.pingidentity.com/auth-node-ref/latest/set-error-details.html
section_ids:
  examples: Examples
  availability: Availability
  inputs: Inputs
  dependencies: Dependencies
  configuration: Configuration
  outputs: Outputs
  callbacks: Callbacks
  outcomes: Outcomes
  errors: Errors
---

# Set Error Details node

The Set Error Details node adds details to the JSON response when a journey ends in an error. You can configure the node properties to return an error message and extra information in the form of static `key:value` fields.

Place the Set Error Details node before the node that errors in the journey.

## Examples

This example uses the Set Error Details node to handle errors from the [Identity Assertion node](identity-assertion-node.html) when the journey ends in an error.

![set error details journey](_images/set-error-details-journey.png)

* The Set Error Details node adds details to the JSON response when the journey ends in an error. This example uses the following configuration:

  * Error Message

    * Key: `en-gb`

    * Value: `Identity assertion failure`

  * Error Details

    * Key: `errorUrl`

    * Value: `https://example.com/error`

* The Identity Assertion node is configured as described in the [documentation](identity-assertion-node.html).

  If an error is encountered, the Set Error Details node displays the configured message to the user and adds both the message and the details to the JSON response.

  For example:

  ```json
  {
      "code": 401,
      "reason": "Unauthorized",
      "message": "Identity assertion failure",
      "detail": {
        "errorUrl": "https://example.com/error"
      }
  }
  ```

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

This node has no dependencies.

## Configuration

| Property      | Usage                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |
| ------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Error Message | The message to add to the JSON response when a journey ends in an error.Add a custom, localized message per locale:1) Click [icon: plus, set=fa].

2) In the Key field, enter the locale. For example, `en-gb`.[1](#locale-footnote)

3) In the Value field, enter the message. For example, `Invalid outcome from script`.

4) Click Done.

5) Repeat to add more messages and save your changes when you're done.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| Error Details | The details to add to the JSON response when a journey ends in an error:1) Click [icon: plus, set=fa].

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

3) In the Value field, enter the details to return. For example, `https://example.com`.

   The value can be a simple text string, a boolean value, or a JSON formatted value. The value is formatted appropriately when output in the JSON response.

   For example:

   Key	Value	Output

example

	

this is a test value

	
"example": "this is a test value"



boolean

	

true

	
"boolean": true



field

	

{ "nested": "nested value" }

	
"field": {
   "nested": "nested value"
}

4) Click Done.

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

6) Save your changes. |

(1) Specify a [locale that Java supports](https://docs.oracle.com/en/java/javase/17/docs/api/java.base/java/util/Locale.html), such as `en-gb`. Otherwise, the node throws a configuration exception with an `Invalid locale provided` message.

## Outputs

The node adds the `ErrorDetailsTreeHook`, which runs when the tree completes. Learn more in [Create tree hooks](https://docs.pingidentity.com/pingam/8/am-authentication/post-authn-plugins-treehook.html).

## Callbacks

This node doesn't send any callbacks.

## Outcomes

Single outcome path: when the journey ends in an error, this node adds the configured details to the JSON response.

## Errors

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