Legacy Social Provider Handler node

This legacy node is similar to the newer Social Provider Handler node. It takes a provider selection from the Select Identity Provider node and attempts to authenticate the user. The node collects relevant profile information from the provider, transforms the profile information into the appropriate attributes and returns the user to the journey.

This node remains supported in existing journeys. For new journeys, use the Social Provider Handler node instead.

Implement this node with the Select Identity Provider node to use the Social Identity Provider Service.

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

Outcomes

Account exists: Social authentication succeeded, and a matching Advanced Identity Cloud or AM account exists.
No account exists: Social authentication succeeded, but no matching Advanced Identity Cloud or AM account exists.

Properties

Property Usage

Property	Usage
Transformation Script (required)	This script is used after the configured provider’s normalization script has mapped the social identity provider’s attributes to a profile format compatible with AM. The transformation script then transforms a normalized social profile to an identity or a managed object. For PingAM select `Normalized Profile to Identity`, or a custom script you’ve created to transform the profile to an identity object. Find information on the scripts and bindings in normalized-profile-to-identity.js. For Advanced Identity Cloud and Ping Identity Platform deployments, select `Normalized Profile to Managed User` (default), or a custom script you’ve created to transform the profile to a managed object. Find information on the scripts and bindings in normalized-profile-to-managed-user.js. Normalization scripts (`<Identity provider>-profile-normalization.*`) are not suitable for this purpose.
Username Attribute	Advanced Identity Cloud and Ping Identity Platform deployments only The attribute in the underlying identity service (PingIDM) that contains the username for this object.
Client Type	Specify the client type you are using to authenticate to the provider. Use the default, `BROWSER`, with ForgeRock-provided user interfaces or the Ping SDK for JavaScript. This causes the node to return the Redirect callback. Find more information in the documentation on this callback for: Advanced Identity Cloud PingAM Select `NATIVE` with the Ping SDKs for Android or iOS. This causes the node to return the IdP callback. Find more information in the documentation on this callback for: Advanced Identity Cloud PingAM
Store Tokens	When `true`, the node stores access and refresh tokens in the transient state for use by subsequent nodes in the journey. In some cases, the social provider requires these tokens, for example, to revoke user authorization. If you choose to store tokens, you can configure a Scripted Decision node later in the journey to handle your social provider use case. Default: `false`

Transformation Script (required)

This script is used after the configured provider’s normalization script has mapped the social identity provider’s attributes to a profile format compatible with AM. The transformation script then transforms a normalized social profile to an identity or a managed object.

For PingAM select Normalized Profile to Identity, or a custom script you’ve created to transform the profile to an identity object.

Find information on the scripts and bindings in normalized-profile-to-identity.js.
For Advanced Identity Cloud and Ping Identity Platform deployments, select Normalized Profile to Managed User (default), or a custom script you’ve created to transform the profile to a managed object.

Find information on the scripts and bindings in normalized-profile-to-managed-user.js.

Normalization scripts (<Identity provider>-profile-normalization.*) are not suitable for this purpose.

Username Attribute

Advanced Identity Cloud and Ping Identity Platform deployments only

The attribute in the underlying identity service (PingIDM) that contains the username for this object.

Client Type

Specify the client type you are using to authenticate to the provider.

Use the default, BROWSER, with ForgeRock-provided user interfaces or the Ping SDK for JavaScript. This causes the node to return the Redirect callback.

Find more information in the documentation on this callback for:

Select NATIVE with the Ping SDKs for Android or iOS. This causes the node to return the IdP callback.

Find more information in the documentation on this callback for:

Store Tokens

When true, the node stores access and refresh tokens in the transient state for use by subsequent nodes in the journey.

In some cases, the social provider requires these tokens, for example, to revoke user authorization. If you choose to store tokens, you can configure a Scripted Decision node later in the journey to handle your social provider use case.

Default: false