Read-only callbacks

Nodes use these callbacks to return information to the client application or to display information to the user.

HiddenValueCallback

Provides form values that are to remain hidden from the user.

Example

{
  "callbacks": [{
    "type": "HiddenValueCallback",
    "output": [{
      "name": "value",
      "value": "6186c911-b3be-4dbc-8192-bdf251392072"
    }, {
      "name": "id",
      "value": "jwt"
    }],
    "input": [{
      "name": "IDToken1",
      "value": "jwt"
    }]
  }]
}

Class to import in scripts: com.sun.identity.authentication.callbacks.HiddenValueCallback

MetadataCallback

Injects key-value pairs into the authentication process.

Example

{
  "callbacks": [{
    "type": "MetadataCallback",
    "output": [{
      "name": "data",
      "value": {
        "myParameter": "MyValue"
      }
    }]
  }]
}

Class to import in scripts: com.sun.identity.authentication.spi.MetadataCallback

PollingWaitCallback

Indicates the number of milliseconds to wait before responding to the callback.

Example

{
  "callbacks": [{
    "type": "PollingWaitCallback",
    "output": [{
      "name": "waitTime",
      "value": "8000"
    }, {
      "name": "message",
      "value": "Waiting for response..."
    }]
  }]
}

Class to import in scripts: org.forgerock.openam.authentication.callbacks.PollingWaitCallback

RedirectCallback

Redirects the user-agent.

The Social Provider Handler node returns this callback when its Client Type is set to BROWSER, and the client must redirect the user to the social provider for authentication.

Example

{
  "callbacks": [{
    "type": "RedirectCallback",
    "output": [{
      "name": "redirectUrl",
      "value": "https://accounts.google.com/o/oauth2/v2/auth?nonce..."
    }, {
      "name": "redirectMethod",
      "value": "GET"
    }, {
      "name": "trackingCookie",
      "value": true
    }]
  }]
}

Identity Cloud uses a trackingCookie to store the authentication identifier that reflects the client’s place in the authentication process.

Class to import in scripts: com.sun.identity.authentication.spi.RedirectCallback

SuspendedTextOutputCallback

Provides a message to display to the user when the authentication journey is suspended.

Callback output field Description

Callback output field	Description
`message`	A string containing a message to display to the user.
`messageType`	A number indicating the severity of the message: `0`: Information `1`: Warning `2`: Error

message

A string containing a message to display to the user.

messageType

A number indicating the severity of the message:

0: Information
1: Warning
2: Error

Example

{
  "callbacks": [{
    "type": "SuspendedTextOutputCallback",
    "output": [{
      "name": "message",
      "value": "An email has been sent to your inbox."
    }, {
      "name": "messageType",
      "value": "0"
    }]
  }]
}

Class to import in scripts: org.forgerock.openam.auth.node.api.SuspendedTextOutputCallback

TextOutputCallback

Provides a message to display to the user.

Callback output field Description

Callback output field	Description
`message`	A string containing a message to display to the user.
`messageType`	A number indicating the severity of the message: `0`: Information `1`: Warning `2`: Error

message

A string containing a message to display to the user.

messageType

A number indicating the severity of the message:

0: Information
1: Warning
2: Error

Example

{
  "callbacks": [{
    "type": "TextOutputCallback",
    "output": [{
      "name": "message",
      "value": "Default message"
    }, {
      "name": "messageType",
      "value": "0"
    }]
  }]
}

Class to import in scripts: javax.security.auth.callback.TextOutputCallback