Polling Wait node

Pauses authentication progress for a specified number of seconds, for example, to wait for a response to a one-time passcode email or push notification.

The end user UI automatically waits for the required amount of time and resubmits the page to continue evaluation. During the wait period, a configurable message is shown to the user to keep them informed.

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

Properties

Property Usage

Property	Usage
Seconds To Wait	Specify the number of seconds to pause authentication. Default: `8`
Enable Spam Detection	Specify whether to track the number of responses received during the wait time, and continue evaluation along the `Spam` outcome path if the number specified in the Spam Tolerance property is exceeded. Default: Disabled
Spam Tolerance	Specify the number of responses to allow during the wait time before continuing evaluation along the `Spam` outcome path. This property only applies if spam detection is enabled. Default: `3`
Waiting Message	Specifies the optional message to display to the user. Provide the message in multiple languages by specifying the locale in the KEY field. For example, `en-gb` .⁽¹⁾ The locale selected for display is based on the user’s locale settings in their browser. Leave blank to use the default message.⁽²⁾
Exitable	Whether the user can exit the node during the wait period. Enabling this option adds a button with a configurable message to the page. Clicking the button causes evaluation to continue along the `Exited` outcome path. Default: Disabled
Exit Message	Specifies the optional message to display to the user on the button used to exit the node before the wait period has elapsed. For example, `Cancel` or `Lost phone? Use Recovery Code`. This property only applies if the Exitable property is enabled. Provide the message in multiple languages by specifying the locale in the KEY field. For example, `en-gb`.⁽¹⁾ The locale selected for display is based on the user’s locale settings in their browser. Leave blank to use the default message.⁽²⁾

Seconds To Wait

Specify the number of seconds to pause authentication.

Default: 8

Enable Spam Detection

Specify whether to track the number of responses received during the wait time, and continue evaluation along the Spam outcome path if the number specified in the Spam Tolerance property is exceeded.

Default: Disabled

Spam Tolerance

Specify the number of responses to allow during the wait time before continuing evaluation along the Spam outcome path. This property only applies if spam detection is enabled.

Default: 3

Waiting Message

Specifies the optional message to display to the user.

Provide the message in multiple languages by specifying the locale in the KEY field. For example, en-gb .⁽¹⁾

The locale selected for display is based on the user’s locale settings in their browser.

Leave blank to use the default message.⁽²⁾

Exitable

Whether the user can exit the node during the wait period.

Enabling this option adds a button with a configurable message to the page. Clicking the button causes evaluation to continue along the Exited outcome path.

Default: Disabled

Exit Message

Specifies the optional message to display to the user on the button used to exit the node before the wait period has elapsed. For example, Cancel or Lost phone? Use Recovery Code. This property only applies if the Exitable property is enabled.

Provide the message in multiple languages by specifying the locale in the KEY field. For example, en-gb.⁽¹⁾

The locale selected for display is based on the user’s locale settings in their browser.

Leave blank to use the default message.⁽²⁾

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

⁽²⁾ Learn more about customizing and translating default messages in Internationalize nodes.

Outputs

This node doesn’t change the shared state.

Callbacks

The node sends a PollingWaitCallback and an authentication ID to any requests made during the wait period. For example, the following callback indicates a wait period of 10 seconds:

{
    "authId": "eyJ0eXAiOiJK...u4WvZmiI",
    "callbacks": [
        {
            "type": "PollingWaitCallback",
            "output": [
                {
                    "name": "waitTime",
                    "value": "10000"
                },
                {
                    "name": "message",
                    "value": "Waiting for response..."
                }
            ]
        }
    ]
}

The client must wait 10 seconds before returning the callback data, including the authId:

$ **curl \
--request POST \
--header "iPlanetDirectoryPro: admin-tokenId" \
--header "Accept-API-Version: resource=2.0, protocol=1.0" \
--header "Content-Type: application/json" \
--data '{
  "authId": "eyJ0eXAiOiJK…u4WvZmiI",
  "callbacks": [
      {
          "type": "PollingWaitCallback",
          "output": [
              {
                  "name": "waitTime",
                  "value": "10000"
              },
              {
                  "name": "message",
                  "value": "Waiting for response…"
              }
          ]
      }
  ]
}' \
'https://am.example.com:8443/am/json/realms/root/realms/alpha/authenticate?authIndexType=service&authIndexValue=Example'

Learn more in PollingWaitCallback.

Outcomes

Done: A request is received after the wait period has elapsed.
Exited: The user clicked the Cancel button to exit the node.

This outcome is only available if the Exitable option is selected.
Spam: The number of requests received exceeds the number specified in the Spam Tolerance property.

This outcome is only available if the Enable Spam Detection option is selected.

Errors

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

PingAM Auth node reference