pingcli pingone protect risk-predictors template

Generate a risk predictor JSON template

Synopsis

Generate a JSON skeleton template for risk predictor create or replace bodies.

Select the desired type with --template-type (one of: adversaryInTheMiddle, anonymousNetwork, bot, composite, custom, device, emailReputation, geovelocity, ipReputation, trafficAnomaly, userLocationAnomaly, userRiskBehavior, velocity). Defaults to device when omitted.

Note: compactName is required for both create and replace bodies. It is immutable after creation — the SDK always serialises it and the API rejects an empty compactName string.

pingcli pingone protect risk-predictors template [flags]

Examples

  # Generate a device risk predictor template and save to a file
  pingcli pingone protect risk-predictors template --template-type device > body.json

  # Edit the template — fill in the required fields, then pass the body to
  # the create or replace command
Use the JSON template as a starting point:
  1. Run the template command to generate the body skeleton.
  2. Edit the file, replacing placeholder values with real data.
  3. Feed the edited file back to the create or replace action via --from-file.

Example workflow:
  pingcli pingone protect risk-predictors template > body.json
  # edit body.json
  pingcli pingone protect risk-predictors create --from-file body.json

Options

  -o, --output-file string     Write the JSON template to PATH instead of stdout. Overwrites any existing file.
  -h, --help                   help for template
      --template-type string   The variant of the template to generate. One of: adversaryInTheMiddle, anonymousNetwork, bot, composite, custom, device, emailReputation, geovelocity, ipReputation, trafficAnomaly, userLocationAnomaly, userRiskBehavior, velocity. Defaults to "device".

Options inherited from parent commands

  -C, --config string           The relative or full path to a custom Ping CLI configuration file. (default $HOME/.pingcli/config.yaml)
  -D, --detailed-exitcode       Enable detailed exit code output. (default false) 0 - pingcli command succeeded with no errors or warnings. 1 - pingcli command failed with errors. 2 - pingcli command succeeded with warnings.
  -O, --output-format string    Specify the console output format. (default text) Options are: json, ndjson, ndjson-typed, ndjson-wrapped, text.
  -P, --profile string          The name of a configuration profile to use.
      --debug                   Enable debug output for error messages, including stack traces and transaction IDs. (default false)
      --log-file string         Write logs to a file at the given path. File logging is disabled when not set.
      --log-file-level string   Set the file log level. Options are: DEBUG, INFO, WARN, ERROR. (default DEBUG)
      --log-level string        Set the console log level. Options are: DEBUG, INFO, WARN, ERROR. (default WARN)
      --no-color                Disable text output in color. (default false)
      --query string            JMESPath expression to filter JSON output. Requires -O json, ndjson, ndjson-typed, or ndjson-wrapped. Example: --query 'data[?enabled].name'

More information

pingcli pingone protect risk-predictors - Risk Predictors