PingOneProtectInitialize
Realm Operations
Resource path:
/realm-config/authentication/authenticationtrees/nodes/product-PingOneProtectInitializeNode/1.0
Resource version: 3.0
create
Usage
am> create PingOneProtectInitialize --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" : { "agentTimeout" : { "title" : "Timeout for PingID Agent", "description" : "The time, in milliseconds, for establishing a connection with the PingID Device Trust Agent. If left blank, the default value is set by the Signals SDK. If specified, the value must be between 200 and 10,000 milliseconds.", "propertyOrder" : 1200, "type" : "integer", "exampleValue" : "" }, "agentIdentification" : { "title" : "Enable PingID Agent Identification", "description" : "When enabled, the Signals SDK collects attributes from the PingID Device Trust Agent.", "propertyOrder" : 1100, "type" : "boolean", "exampleValue" : "" }, "enableTrust" : { "title" : "Enable Universal Device Identification", "description" : "Tie the device payload to a non-extractable crypto key stored on the browser for content authenticity verification.", "propertyOrder" : 900, "type" : "boolean", "exampleValue" : "" }, "additionalSignalsInitializationOptions" : { "title" : "Additional Signals SDK Initialization Options", "description" : "Map of additional Signals SDK initialization options not covered by existing configuration options. Keys must not duplicate existing options configured in the node.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "disableTags" : { "title" : "Disable Tags", "description" : "When enabled the SDK will collect tag data. When not enabled (the default), tag data is not collected.", "propertyOrder" : 1000, "type" : "boolean", "exampleValue" : "" }, "behavioralDataCollection" : { "title" : "Collect Behavioral Data", "description" : "When enabled (the default), collect behavioral data. When not enabled, behavioral data is not collected.", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "agentPort" : { "title" : "Port number for PingID Agent", "description" : "The port number to use when connecting to the PingID Device Trust Agent. If left blank, the default port 9400 will be used.", "propertyOrder" : 1300, "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" : "" } }, "required" : [ "agentIdentification", "enableTrust", "additionalSignalsInitializationOptions", "disableTags", "behavioralDataCollection", "pingOneWorker" ] }
delete
Usage
am> delete PingOneProtectInitialize --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 PingOneProtectInitialize --realm Realm --actionName getType
getUpgradedConfig
Get the upgraded configuration for the node type.
Usage
am> action PingOneProtectInitialize --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 PingOneProtectInitialize --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 PingOneProtectInitialize --realm Realm --filter filter
Parameters
- --filter
-
A CREST formatted query filter, where "true" will query all.
read
Usage
am> read PingOneProtectInitialize --realm Realm --id id
Parameters
- --id
-
The unique identifier for the resource.
update
Usage
am> update PingOneProtectInitialize --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" : { "agentTimeout" : { "title" : "Timeout for PingID Agent", "description" : "The time, in milliseconds, for establishing a connection with the PingID Device Trust Agent. If left blank, the default value is set by the Signals SDK. If specified, the value must be between 200 and 10,000 milliseconds.", "propertyOrder" : 1200, "type" : "integer", "exampleValue" : "" }, "agentIdentification" : { "title" : "Enable PingID Agent Identification", "description" : "When enabled, the Signals SDK collects attributes from the PingID Device Trust Agent.", "propertyOrder" : 1100, "type" : "boolean", "exampleValue" : "" }, "enableTrust" : { "title" : "Enable Universal Device Identification", "description" : "Tie the device payload to a non-extractable crypto key stored on the browser for content authenticity verification.", "propertyOrder" : 900, "type" : "boolean", "exampleValue" : "" }, "additionalSignalsInitializationOptions" : { "title" : "Additional Signals SDK Initialization Options", "description" : "Map of additional Signals SDK initialization options not covered by existing configuration options. Keys must not duplicate existing options configured in the node.", "propertyOrder" : 1400, "patternProperties" : { ".*" : { "type" : "string" } }, "type" : "object", "exampleValue" : "" }, "disableTags" : { "title" : "Disable Tags", "description" : "When enabled the SDK will collect tag data. When not enabled (the default), tag data is not collected.", "propertyOrder" : 1000, "type" : "boolean", "exampleValue" : "" }, "behavioralDataCollection" : { "title" : "Collect Behavioral Data", "description" : "When enabled (the default), collect behavioral data. When not enabled, behavioral data is not collected.", "propertyOrder" : 600, "type" : "boolean", "exampleValue" : "" }, "agentPort" : { "title" : "Port number for PingID Agent", "description" : "The port number to use when connecting to the PingID Device Trust Agent. If left blank, the default port 9400 will be used.", "propertyOrder" : 1300, "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" : "" } }, "required" : [ "agentIdentification", "enableTrust", "additionalSignalsInitializationOptions", "disableTags", "behavioralDataCollection", "pingOneWorker" ] }