Advanced Identity Cloud

Set Error Details node

PingAM

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.

Compatibility

Product Compatible?

Advanced Identity Cloud

No

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

Inputs

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

Dependencies

None.

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 .

  2. In the Key field, enter the locale. For example, en-gb.1

  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 .

  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"
    json

    boolean

    true

    		 
    "boolean": true
    json

    field

    { "nested": "nested value" }

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

  4. Click Done.

  5. Click Add to repeat and add more messages.

  6. Save your changes.

1 Specify a locale that Java supports, such as en-gb. Otherwise, the node throws a configuration exception with an Invalid locale provided message.

Outputs

This node doesn’t change the shared state.

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 messages of its own.

Examples

This example uses the Set Error Details node to handle errors from the Identity Assertion node when the journey ends in an error.

set error details journey

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

    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:

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