State Metadata node

The State Metadata node returns selected attributes from the shared node state as metadata.

This node sends a MetadataCallback to retrieve shared state values, which it adds to the JSON response from the /authenticate endpoint. This example shows how a shared state attribute, mail, is returned:

{
    "callbacks": [
        {
            "type": "MetadataCallback",
            "output": [
                {
                    "name": "data",
                    "value": {
                        "mail": "bjensen@example.com"
                    }
                }
            ]
        }
    ]
}

Compatibility

Product	Compatible?
Advanced Identity Cloud	Yes
PingAM (self-managed)	Yes
Ping Identity Platform (self-managed)	Yes

Product

Compatible?

Advanced Identity Cloud

Yes

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

Inputs

This node reads its configured Attributes from the shared node state.

Dependencies

None.

Configuration

Property	Usage
Attributes	Specify one or more shared state attribute names for return. Default: none

Property

Usage

Attributes

Specify one or more shared state attribute names for return.

Default: none

Outputs

This node only sends the callback. It does not modify the shared node state.

Outcomes

Single outcome path.

Evaluation continues after the callback.

Errors

This node does not log error or warning messages of its own.

Example

Use this node to display custom information that includes user attributes without having to alter the existing flow.

For example, for OTP authentication with a choice of email or SMS, use this node to return the user’s email address or phone number. You can use the attributes with an OTP Collector Decision node, and optionally, a Scripted Decision node, to customize the data for display later.

An example of OTP authentication with a State Metadata node.

The Page node with a Platform Username node and Attribute Collector node prompts for the credentials.
The Data Store Decision node confirms the user’s credentials.
The Choice Collector node lets the user opt for notification through email or a text message.
The OTP Email Sender node sends the one-time password (OTP) as email.
The OTP SMS Sender node sends the OTP as a text message.
The State Metadata node injects attributes for additional information.
The OTP Collector Decision node displays the additional information when collecting the OTP to verify.