PingAM

PingOneDeleteUser

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/PingOneDeleteUserNode/1.0

Resource version: 3.0

create

Usage

am> create PingOneDeleteUser --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneDeleteUserFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "pingOneWorker", "captureFailure" ]
}

delete

Usage

am> delete PingOneDeleteUser --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getType

List information related to the node such as a name, description, tags and metadata.

Usage

am> action PingOneDeleteUser --realm Realm --actionName getType

getUpgradedConfig

Get the upgraded configuration for the node type.

Usage

am> action PingOneDeleteUser --realm Realm --body body --actionName getUpgradedConfig --targetVersion targetVersion

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "title" : "The current configuration of the node type."
}
--targetVersion

=== listOutcomes

List the available outcomes for the node type.

Usage

am> action PingOneDeleteUser --realm Realm --body body --actionName listOutcomes

Parameters

--body

The resource in JSON format, described by the following JSON schema:

{
  "description" : "Some configuration of the node. This does not need to be complete against the configuration schema.",
  "type" : "object",
  "title" : "Node configuration"
}

query

Get the full list of instances of this collection. This query only supports _queryFilter=true filter.

Usage

am> query PingOneDeleteUser --realm Realm --filter filter

Parameters

--filter

A CREST formatted query filter, where "true" will query all.

read

Usage

am> read PingOneDeleteUser --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update PingOneDeleteUser --realm Realm --id id --body body

Parameters

--id

The unique identifier for the resource.

--body

The resource in JSON format, described by the following JSON schema:

{
  "type" : "object",
  "properties" : {
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneDeleteUserFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    }
  },
  "required" : [ "pingOneWorker", "captureFailure" ]
}

versionInfo

List the versions available for the node type.

Usage

am> action PingOneDeleteUser --realm Realm --actionName versionInfo