Advanced Identity Cloud

Set Failure Details node

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

Compatibility

Product Compatible?

Advanced Identity Cloud

Yes 1

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

1 Currently available only in the rapid release channel.

Inputs

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

Dependencies

None.

Configuration

Property Usage

Failure Message

The message to add to the JSON response when authentication fails:

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, Your account has been locked.

  4. Click Done.

  5. Repeat to add more messages and save your changes when you’re done.

Failure Details

The details to add to the JSON response on journey failure:

  1. Click .

  2. In the Key field, enter a name to identify the details. For example, Reason.

  3. In the Value field, enter the details to return. For example, Exceeded max retries.

    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 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 failure, 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 Failure Details node and assumes the following configuration:

Failure Message

  • Key: en-gb

  • Value: Your account is locked

Failure Details

  • Key: Reason

  • Value: Exceeded max retries

set failure success details journey

  • The Page node containing the Platform Username node and Platform Password node prompts for credentials.

  • The Data Store Decision node validates the username-password credentials.

  • If authentication is successful:

  • If authentication fails:

    • The Retry Limit Decision node checks the number of failed authentications against the configured limit. If the retry limit is reached, the journey continues on the Reject outcome path.

    • The Account Lockout node locks the account.

    • The Set Failure 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":"Your account is locked",
  "detail":{
    "Reason":"Exceeded max retries"
  }
}
Copyright © 2010-2024 ForgeRock, all rights reserved.