Patch Object node

The Patch Object node updates the attributes of an existing managed identity object.

Compatibility

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

Product

Compatible?

ForgeRock Identity Cloud

Yes

ForgeRock Access Management (self-managed)

Yes

ForgeRock Identity Platform (self-managed)

Yes

Inputs

This node reads the Identity Attribute and the managed object fields to patch from the shared node state. If it can’t read the Identity Attribute, it reads the userName from the shared node state.

Dependencies

This node depends on the underlying identity service to find and patch the managed object.

Configuration

Property Usage

Patch as Object

If enabled, update the object as its subject—for example, update a managed user object as the user; otherwise, update the object as the client application.

Enable this property to patch fields of the current, authenticated user’s account the client application can’t update.

Default: false

Ignored Fields

Omit the specified shared state fields from the patch.

If no fields are specified, the node attempts to update all the shared state fields as part of the patch.

Default: none

Identity Resource

The type of managed identity resource object this node patches.

This must match the identity resource type for the current flow.

To check for the available managed identity resource types, go to the IDM admin UI, and open the Manage drop-down list in the upper right corner of the screen.

Identity managed object types are preceded by the icon.

Default: managed/user

Identity Attribute

The attribute used to identify the managed object in the underlying identity service.

Default: userName

Outputs

None.

Outcomes

Patched: The node updated the managed object.
False: Any other case.

Errors

This node logs the following warning messages when an update fails:

Failed to create object
Failed to patch object

Review the logs for additional messages describing the problem.

Example

This journey uses the Patch Object node to update a user’s password:

The user has already authenticated before beginning this journey:

The Get Session Data node stores the userName from the session.
The Attribute Present Decision node checks whether the user object has a password attribute.
If so, the first Page node with the Platform Password node prompts the user for the current password.
Otherwise, the Email Suspend node sends an email to the user and suspends the flow until the user follows the link in the message.
The Data Store Decision node confirms the username-password credentials.
The second Page node with the Platform Password node prompts the user for the new password.
The Patch Object node updates the user object with the new password.