Amster

PingOneVerifyEvaluation

Realm Operations

Resource path:

/realm-config/authentication/authenticationtrees/nodes/PingOneVerifyEvaluationNode

Resource version: 2.0

create

Usage

am> create PingOneVerifyEvaluation --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" : {
    "storeVerifiedData" : {
      "title" : "Store verified data",
      "description" : "Store the list of verified data submitted by the user in the shared state under a keynamed <code>pingOneVerifyVerifiedData</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve the verified data from PingOne.",
      "propertyOrder" : 1200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "deliveryMethodMessage" : {
      "title" : "Delivery method message",
      "description" : "The message to display to the user allowing them to choose the delivery method to receive the verify URL (QRCODE, SMS, EMAIL).",
      "propertyOrder" : 500,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "storeVerificationMetadata" : {
      "title" : "Store verification metadata",
      "description" : "Store verification metadata from PingOne Verify in the shared state under a keynamed <code>pingOneVerifyMetadata</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve the verification metadata from PingOne.",
      "propertyOrder" : 1100,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "allowDeliveryMethodSelection" : {
      "title" : "Allow user to choose the URL delivery method",
      "description" : "If enabled, prompt the user to select the URL delivery method. This does not apply if the delivery method is set to <code>Redirect</code>.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "redirectMessage" : {
      "title" : "Redirect message",
      "description" : "The message to display to the user after the identity verification process is complete and the user is redirected back to the Journey.",
      "propertyOrder" : 800,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "deliveryMethod" : {
      "title" : "Verify URL delivery method",
      "description" : "The delivery method for the Verify URL. Choose from: <ul><li><code>QRCODE</code>: Display the URL as a QR code (default)</li><li><code>EMAIL</code>: Send an email containing the URL to the email address in the user's profile</li><li><code>SMS</code>: Send an SMS containing the URL to the phone number in the user's profile</li><li><code>REDIRECT</code>: Redirect the user to the Verify Web app</li>",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "timeout" : {
      "title" : "Verify transaction timeout",
      "description" : "The period of time (in seconds) to wait for a response to the Verify transaction. If no response is received during this time the node times out and the verification process fails.",
      "propertyOrder" : 900,
      "type" : "integer",
      "exampleValue" : ""
    },
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "verifyPolicyId" : {
      "title" : "Verify policy ID",
      "description" : "The ID of the Verify policy. <br><br>If not specified, the node uses the environment's default Verify policy.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneVerifyEvaluationFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 1300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "waitingMessage" : {
      "title" : "Waiting message",
      "description" : "Localization overrides for the waiting message. This is a map of locale to message.",
      "propertyOrder" : 700,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "scanQRCodeMessage" : {
      "title" : "QR code message",
      "description" : "The message with instructions to scan the QR code to begin the identity verification process.",
      "propertyOrder" : 600,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "biographicMatching" : {
      "title" : "Biographic matching",
      "description" : "Attributes from the user profile to compare with the data extracted from the government identity document provided by the client. If empty, no biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Accepted biographic matching requirement keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.",
      "propertyOrder" : 1000,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "storeVerifiedData", "deliveryMethodMessage", "storeVerificationMetadata", "allowDeliveryMethodSelection", "redirectMessage", "deliveryMethod", "timeout", "pingOneWorker", "verifyPolicyId", "captureFailure", "waitingMessage", "scanQRCodeMessage", "biographicMatching" ]
}

delete

Usage

am> delete PingOneVerifyEvaluation --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 PingOneVerifyEvaluation --realm Realm --actionName getAllTypes

getCreatableTypes

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

Usage

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

listOutcomes

List the available outcomes for the node type.

Usage

am> action PingOneVerifyEvaluation --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 PingOneVerifyEvaluation --realm Realm --actionName nextdescendents

query

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

Usage

am> query PingOneVerifyEvaluation --realm Realm --filter filter

Parameters

--filter

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

read

Usage

am> read PingOneVerifyEvaluation --realm Realm --id id

Parameters

--id

The unique identifier for the resource.

update

Usage

am> update PingOneVerifyEvaluation --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" : {
    "storeVerifiedData" : {
      "title" : "Store verified data",
      "description" : "Store the list of verified data submitted by the user in the shared state under a keynamed <code>pingOneVerifyVerifiedData</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve the verified data from PingOne.",
      "propertyOrder" : 1200,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "deliveryMethodMessage" : {
      "title" : "Delivery method message",
      "description" : "The message to display to the user allowing them to choose the delivery method to receive the verify URL (QRCODE, SMS, EMAIL).",
      "propertyOrder" : 500,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "storeVerificationMetadata" : {
      "title" : "Store verification metadata",
      "description" : "Store verification metadata from PingOne Verify in the shared state under a keynamed <code>pingOneVerifyMetadata</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve the verification metadata from PingOne.",
      "propertyOrder" : 1100,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "allowDeliveryMethodSelection" : {
      "title" : "Allow user to choose the URL delivery method",
      "description" : "If enabled, prompt the user to select the URL delivery method. This does not apply if the delivery method is set to <code>Redirect</code>.",
      "propertyOrder" : 400,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "redirectMessage" : {
      "title" : "Redirect message",
      "description" : "The message to display to the user after the identity verification process is complete and the user is redirected back to the Journey.",
      "propertyOrder" : 800,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "deliveryMethod" : {
      "title" : "Verify URL delivery method",
      "description" : "The delivery method for the Verify URL. Choose from: <ul><li><code>QRCODE</code>: Display the URL as a QR code (default)</li><li><code>EMAIL</code>: Send an email containing the URL to the email address in the user's profile</li><li><code>SMS</code>: Send an SMS containing the URL to the phone number in the user's profile</li><li><code>REDIRECT</code>: Redirect the user to the Verify Web app</li>",
      "propertyOrder" : 300,
      "type" : "string",
      "exampleValue" : ""
    },
    "timeout" : {
      "title" : "Verify transaction timeout",
      "description" : "The period of time (in seconds) to wait for a response to the Verify transaction. If no response is received during this time the node times out and the verification process fails.",
      "propertyOrder" : 900,
      "type" : "integer",
      "exampleValue" : ""
    },
    "pingOneWorker" : {
      "title" : "PingOne Worker service ID",
      "description" : "The ID of the PingOne Worker service for connecting to PingOne.",
      "propertyOrder" : 100,
      "type" : "string",
      "exampleValue" : ""
    },
    "verifyPolicyId" : {
      "title" : "Verify policy ID",
      "description" : "The ID of the Verify policy. <br><br>If not specified, the node uses the environment's default Verify policy.",
      "propertyOrder" : 200,
      "type" : "string",
      "exampleValue" : ""
    },
    "captureFailure" : {
      "title" : "Capture failure",
      "description" : "If selected, a failure is captured in shared state under a key named <code>pingOneVerifyEvaluationFailureReason</code> for use by subsequent nodes in the journey.",
      "propertyOrder" : 1300,
      "type" : "boolean",
      "exampleValue" : ""
    },
    "waitingMessage" : {
      "title" : "Waiting message",
      "description" : "Localization overrides for the waiting message. This is a map of locale to message.",
      "propertyOrder" : 700,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "scanQRCodeMessage" : {
      "title" : "QR code message",
      "description" : "The message with instructions to scan the QR code to begin the identity verification process.",
      "propertyOrder" : 600,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    },
    "biographicMatching" : {
      "title" : "Biographic matching",
      "description" : "Attributes from the user profile to compare with the data extracted from the government identity document provided by the client. If empty, no biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Accepted biographic matching requirement keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.",
      "propertyOrder" : 1000,
      "patternProperties" : {
        ".*" : {
          "type" : "string"
        }
      },
      "type" : "object",
      "exampleValue" : ""
    }
  },
  "required" : [ "storeVerifiedData", "deliveryMethodMessage", "storeVerificationMetadata", "allowDeliveryMethodSelection", "redirectMessage", "deliveryMethod", "timeout", "pingOneWorker", "verifyPolicyId", "captureFailure", "waitingMessage", "scanQRCodeMessage", "biographicMatching" ]
}