PingOneVerifyEvaluation
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/PingOneVerifyEvaluationNode/1.0
Resource version: 3.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" : { "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" : "" }, "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" : "" }, "allowSameDeviceVerification" : { "title" : "Allow same device verification", "description" : "If selected, the user is presented with an option to continue the identity verification process on their current device. This is only available if the delivery method is set to <code>QRCODE</code>.", "propertyOrder" : 350, "type" : "boolean", "exampleValue" : "" }, "nodeStateBiographicMatching" : { "title" : "Node state biographic matching", "description" : "Attributes from the node state to compare with the data extracted from the government identity document provided by the client. If empty, no node state biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Keys must be unique across user profile biographic matching and node state biographic matching. Accepted biographic matching keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.", "propertyOrder" : 1050, "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" : "" }, "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" : "" }, "autoRedirect" : { "title" : "Automatic redirect", "description" : "If enabled, when the delivery method is Redirect, the user is automatically redirected back to the journey after successfully completing the verification process in PingOne Verify.", "propertyOrder" : 450, "type" : "boolean", "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" : "" }, "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" : "" }, "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" : "" }, "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. This field should only be used if Automatic redirect is disabled.", "propertyOrder" : 800, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "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" : "" }, "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" : "" }, "biographicMatching" : { "title" : "User profile 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 user profile biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Keys must be unique across user profile biographic matching and node state biographic matching. Accepted biographic matching keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.", "propertyOrder" : 1000, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker service ID", "description" : "The ID of the PingOne Worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "storeVerificationMetadata", "deliveryMethod", "allowSameDeviceVerification", "nodeStateBiographicMatching", "scanQRCodeMessage", "verifyPolicyId", "autoRedirect", "timeout", "captureFailure", "storeVerifiedData", "deliveryMethodMessage", "redirectMessage", "waitingMessage", "allowDeliveryMethodSelection", "biographicMatching", "pingOneWorker" ] }
delete
Usage
am> delete PingOneVerifyEvaluation --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 PingOneVerifyEvaluation --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action PingOneVerifyEvaluation --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 PingOneVerifyEvaluation --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 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" : { "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" : "" }, "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" : "" }, "allowSameDeviceVerification" : { "title" : "Allow same device verification", "description" : "If selected, the user is presented with an option to continue the identity verification process on their current device. This is only available if the delivery method is set to <code>QRCODE</code>.", "propertyOrder" : 350, "type" : "boolean", "exampleValue" : "" }, "nodeStateBiographicMatching" : { "title" : "Node state biographic matching", "description" : "Attributes from the node state to compare with the data extracted from the government identity document provided by the client. If empty, no node state biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Keys must be unique across user profile biographic matching and node state biographic matching. Accepted biographic matching keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.", "propertyOrder" : 1050, "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" : "" }, "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" : "" }, "autoRedirect" : { "title" : "Automatic redirect", "description" : "If enabled, when the delivery method is Redirect, the user is automatically redirected back to the journey after successfully completing the verification process in PingOne Verify.", "propertyOrder" : 450, "type" : "boolean", "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" : "" }, "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" : "" }, "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" : "" }, "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. This field should only be used if Automatic redirect is disabled.", "propertyOrder" : 800, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "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" : "" }, "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" : "" }, "biographicMatching" : { "title" : "User profile 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 user profile biographic matching verification is performed. Key is the biographic matching requirement. Value is the identity attribute name. Keys must be unique across user profile biographic matching and node state biographic matching. Accepted biographic matching keys: referenceSelfie, phone, email, given_name, family_name, name, address, and birth_date.", "propertyOrder" : 1000, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker service ID", "description" : "The ID of the PingOne Worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" } }, "required" : [ "storeVerificationMetadata", "deliveryMethod", "allowSameDeviceVerification", "nodeStateBiographicMatching", "scanQRCodeMessage", "verifyPolicyId", "autoRedirect", "timeout", "captureFailure", "storeVerifiedData", "deliveryMethodMessage", "redirectMessage", "waitingMessage", "allowDeliveryMethodSelection", "biographicMatching", "pingOneWorker" ] }