Advanced Identity Cloud

PingOne Delete User node

The PingOne Delete User node can delete users from the PingOne platform.

Compatibility

Product Compatible?

Advanced Identity Cloud

Yes 1

PingAM (self-managed)

Yes

Ping Identity Platform (self-managed)

Yes

1 Currently available only in the rapid release channel.

Inputs

This node requires the pingOneUserId variable from node state. The variable must contain the identifier of the user to delete from PingOne. For example, a648aaac-ch15-b357-457b-8d2e714180ff.

Use either of the following nodes to populate the pingOneUserId variable in shared state:

Dependencies

This node requires a PingOne Worker Service configuration so that it can authenticate to your PingOne instance.

You can find information on the properties used by the service in PingOne Worker service.

Configuration

Property Usage

PingOne Worker Service ID

The ID of the PingOne worker service for connecting to PingOne.

Capture failure

Capture the details in shared state if a failure occurs.

The node stores the details in a variable named pingOneDeleteUserFailureReason.

Default: False

Example:

{
  "code": "MISSING_PINGONE_USER_ID",
  "message": "Expected PingOne User ID to be set in sharedState or user's profile.",
  "exception": "",
}

Outputs

The node is non-interactive and does not send a callback to the client.

If you select Capture failure, the node stores any error response in a shared state variable named pingOneDeleteUserFailureReason.

Outcomes

True

The node deleted the account from PingOne.

False

The node did not delete the account from PingOne.

The journey also uses this outcome if any error occurs. Enable Capture Failure to store the details in node state.