Gateway Communication node

The Gateway Communication node provides a secure communication channel with Identity Gateway directly from within a journey.

Compatibility

Product	Compatible?
ForgeRock Identity Cloud	Yes
ForgeRock Access Management (self-managed)	No
ForgeRock Identity Platform (self-managed)	No

Product

Compatible?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

ForgeRock Identity Platform (self-managed)

Any data in the shared state that must be sent to IG.

To use this node, you must configure the Gateway Communication service.

The configurable properties for this node are:

Property Usage

Property	Usage
Identity Gateway Service	IG service set up used for this communication.
IG Route	The name of the route to take when IG is reached.
Mapping to Gateway	Map data sent in a JWT to IG from the shared state in the journey. This is an optional property that is used only when IG needs data. The key is the `Shared State Key` containing the data to map. The value is the `Claim Key Name` in the shared state sent in the claim.
Mapping from Gateway	Map data returned from IG to the shared state in the journey. The key is the IG key in the claim. The value is returned by IG and saved to the shared state.

Identity Gateway Service

IG service set up used for this communication.

IG Route

The name of the route to take when IG is reached.

Mapping to Gateway

Map data sent in a JWT to IG from the shared state in the journey. This is an optional property that is used only when IG needs data.

Mapping from Gateway

Map data returned from IG to the shared state in the journey.

Any data mapped from the claims returned by IG that is stored in the shared state of the journey.

Success: The gateway successfully returned a valid signed and encrypted JWT.
Error: Any error that occurred during an attempt to communicate with the gateway.

If this node logs an error, review the log messages to find the reason for the error and address the issue appropriately.

This example journey highlights the use of the Gateway Communication node to authenticate internal accesses.

Identity Cloud provides sample journeys you can download to understand and address the most common Gateway Communication use cases.