Amster

PingOneVerifyCompletionDecision

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/PingOneVerifyCompletionDecisionNode

Resource version: 2.0

create

Usage

am> create PingOneVerifyCompletionDecision --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" : {
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneVerifyCompletionFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "scriptInputs" : {
      "title" : "Script Inputs",
      "description" : "A list of inputs required by the configuration script.",
      "propertyOrder" : 350,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "useFilterScript" : {
      "title" : "Use a script to process Verify transactions",
      "description" : "",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Manage Verify transactions script",
      "description" : "A custom Decision Node script that evaluates the user's Verify transactions and their metadata.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "captureFailure", "scriptInputs", "useFilterScript", "pingOneWorker", "script" ]
}

delete

Usage

am> delete PingOneVerifyCompletionDecision --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

getAllTypes

Obtain the collection of all secondary configuration types related to the resource.

Usage

am> action PingOneVerifyCompletionDecision --realm Realm --actionName getAllTypes

getCreatableTypes

Obtain the collection of secondary configuration types that have yet to be added to the resource.

Usage

am> action PingOneVerifyCompletionDecision --realm Realm --actionName getCreatableTypes

listOutcomes

List the available outcomes for the node type.

Usage

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

Parameters

--body

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

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

nextdescendents

Obtain the collection of secondary configuration instances that have been added to the resource.

Usage

am> action PingOneVerifyCompletionDecision --realm Realm --actionName nextdescendents

query

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

Usage

am> query PingOneVerifyCompletionDecision --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read PingOneVerifyCompletionDecision --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update PingOneVerifyCompletionDecision --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" : {
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneVerifyCompletionFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "scriptInputs" : {
      "title" : "Script Inputs",
      "description" : "A list of inputs required by the configuration script.",
      "propertyOrder" : 350,
      "items" : {
        "type" : "string"
      },
      "type" : "array",
      "exampleValue" : ""
    },
    "useFilterScript" : {
      "title" : "Use a script to process Verify transactions",
      "description" : "",
      "propertyOrder" : 200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "script" : {
      "title" : "Manage Verify transactions script",
      "description" : "A custom Decision Node script that evaluates the user's Verify transactions and their metadata.",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    }
  },
  "required" : [ "captureFailure", "scriptInputs", "useFilterScript", "pingOneWorker", "script" ]
}