PingOneProtectEvaluation
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/product-PingOneProtectEvaluationNode
Resource version: 2.0
create
Usage
am> create PingOneProtectEvaluation --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" : { "flowType" : { "title" : "Flow Type", "description" : "The type of flow or event for which the risk evaluation is being carried out. Choose from: <ul><li><code>REGISTRATION</code> - initial registration of an account</li><li><code>AUTHENTICATION</code> - standard authentication for login or actions such as password change</li><li><code>ACCESS</code> - verification of whether user can access the relevant application</li><li><code>AUTHORIZATION</code> - verification of whether user is authorized to perform a specific action such as a profile change</li><li><code>TRANSACTION</code> - authentication carried out in the context of a purchase or other one-time transaction</li></ul>", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker Service ID", "description" : "The ID of the PingOne worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "userId" : { "title" : "Node State Attribute For User ID", "description" : "The node state variable that contains the <code>user.id</code> as it appears in PingOne Protect. <br><br>If left blank, the node uses the current context <code>UserId</code> as the user.id.", "propertyOrder" : 1000, "type" : "string", "exampleValue" : "" }, "storeEvaluateResult" : { "title" : "Store Risk Evaluation", "description" : "Stores the risk evaluation response in node state under a key named <code>PingOneProtectEvaluationNode.RISK</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve a risk evaluation from PingOne.", "propertyOrder" : 1200, "type" : "boolean", "exampleValue" : "" }, "targetResourceID" : { "title" : "Target App ID", "description" : "The ID of the target application.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "scoreThreshold" : { "title" : "Score Threshold", "description" : "Scoring higher than this value results in evaluation continuing along the <strong>Exceeds Score Threshold</strong> outcome.", "propertyOrder" : 700, "type" : "string", "exampleValue" : "" }, "deviceSharingType" : { "title" : "Device Sharing Type", "description" : "Whether the device is shared between users or not. <br><br>Choose from <code>UNSPECIFIED</code>, <code>SHARED</code>, or <code>PRIVATE</code>.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "userType" : { "title" : "User Type", "description" : "The type of user associated with the event. <br><br>Choose from <code>PING_ONE</code> or <code>EXTERNAL</code>.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "pauseBehavioralData" : { "title" : "Pause Behavioral Data", "description" : "After receiving the device signal, instruct the client to pause collecting behavioral data.", "propertyOrder" : 900, "type" : "boolean", "exampleValue" : "" }, "recommendedActions" : { "title" : "Recommended Actions", "description" : "A list of recommended actions the risk evaluation could return. Each entry in the list becomes a node outcome. If the score does not exceed the threshold and a recommended action is present in the evaluation, the journey continues down the matching entry in this list.", "propertyOrder" : 800, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "username" : { "title" : "Node State Attribute For Username", "description" : "The node state variable that contains the <code>user.name</code> as it appears in PingOne Protect. <br><br>If left blank, the node uses the current context <code>Username</code> as the user.name.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "riskPolicySetID" : { "title" : "Risk Policy Set ID", "description" : "The ID of the risk policy set. <br><br>If not specified, the environment's default risk policy set is used.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" } }, "required" : [ "flowType", "pingOneWorker", "storeEvaluateResult", "scoreThreshold", "deviceSharingType", "userType", "pauseBehavioralData", "recommendedActions" ] }
delete
Usage
am> delete PingOneProtectEvaluation --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 PingOneProtectEvaluation --realm Realm --actionName getAllTypes
getCreatableTypes
Obtain the collection of secondary configuration types that have yet to be added to the resource.
Usage
am> action PingOneProtectEvaluation --realm Realm --actionName getCreatableTypes
listOutcomes
List the available outcomes for the node type.
Usage
am> action PingOneProtectEvaluation --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 PingOneProtectEvaluation --realm Realm --actionName nextdescendents
query
Get the full list of instances of this collection. This query only supports _queryFilter=true filter.
Usage
am> query PingOneProtectEvaluation --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PingOneProtectEvaluation --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PingOneProtectEvaluation --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" : { "flowType" : { "title" : "Flow Type", "description" : "The type of flow or event for which the risk evaluation is being carried out. Choose from: <ul><li><code>REGISTRATION</code> - initial registration of an account</li><li><code>AUTHENTICATION</code> - standard authentication for login or actions such as password change</li><li><code>ACCESS</code> - verification of whether user can access the relevant application</li><li><code>AUTHORIZATION</code> - verification of whether user is authorized to perform a specific action such as a profile change</li><li><code>TRANSACTION</code> - authentication carried out in the context of a purchase or other one-time transaction</li></ul>", "propertyOrder" : 400, "type" : "string", "exampleValue" : "" }, "pingOneWorker" : { "title" : "PingOne Worker Service ID", "description" : "The ID of the PingOne worker service for connecting to PingOne.", "propertyOrder" : 100, "type" : "string", "exampleValue" : "" }, "userId" : { "title" : "Node State Attribute For User ID", "description" : "The node state variable that contains the <code>user.id</code> as it appears in PingOne Protect. <br><br>If left blank, the node uses the current context <code>UserId</code> as the user.id.", "propertyOrder" : 1000, "type" : "string", "exampleValue" : "" }, "storeEvaluateResult" : { "title" : "Store Risk Evaluation", "description" : "Stores the risk evaluation response in node state under a key named <code>PingOneProtectEvaluationNode.RISK</code>.<br><br><em>Note</em>: The key is empty if the node is unable to retrieve a risk evaluation from PingOne.", "propertyOrder" : 1200, "type" : "boolean", "exampleValue" : "" }, "targetResourceID" : { "title" : "Target App ID", "description" : "The ID of the target application.", "propertyOrder" : 200, "type" : "string", "exampleValue" : "" }, "scoreThreshold" : { "title" : "Score Threshold", "description" : "Scoring higher than this value results in evaluation continuing along the <strong>Exceeds Score Threshold</strong> outcome.", "propertyOrder" : 700, "type" : "string", "exampleValue" : "" }, "deviceSharingType" : { "title" : "Device Sharing Type", "description" : "Whether the device is shared between users or not. <br><br>Choose from <code>UNSPECIFIED</code>, <code>SHARED</code>, or <code>PRIVATE</code>.", "propertyOrder" : 500, "type" : "string", "exampleValue" : "" }, "userType" : { "title" : "User Type", "description" : "The type of user associated with the event. <br><br>Choose from <code>PING_ONE</code> or <code>EXTERNAL</code>.", "propertyOrder" : 600, "type" : "string", "exampleValue" : "" }, "pauseBehavioralData" : { "title" : "Pause Behavioral Data", "description" : "After receiving the device signal, instruct the client to pause collecting behavioral data.", "propertyOrder" : 900, "type" : "boolean", "exampleValue" : "" }, "recommendedActions" : { "title" : "Recommended Actions", "description" : "A list of recommended actions the risk evaluation could return. Each entry in the list becomes a node outcome. If the score does not exceed the threshold and a recommended action is present in the evaluation, the journey continues down the matching entry in this list.", "propertyOrder" : 800, "items" : { "type" : "string" }, "type" : "array", "exampleValue" : "" }, "username" : { "title" : "Node State Attribute For Username", "description" : "The node state variable that contains the <code>user.name</code> as it appears in PingOne Protect. <br><br>If left blank, the node uses the current context <code>Username</code> as the user.name.", "propertyOrder" : 1100, "type" : "string", "exampleValue" : "" }, "riskPolicySetID" : { "title" : "Risk Policy Set ID", "description" : "The ID of the risk policy set. <br><br>If not specified, the environment's default risk policy set is used.", "propertyOrder" : 300, "type" : "string", "exampleValue" : "" } }, "required" : [ "flowType", "pingOneWorker", "storeEvaluateResult", "scoreThreshold", "deviceSharingType", "userType", "pauseBehavioralData", "recommendedActions" ] }