Configuration Automation - Ping CLI

pingcli pingone populations apply

Create or update a population

Synopsis

Idempotently create or update a population looked up by the "name" field in the JSON body within the supplied --environment-id. If no population with the given name exists it is created; if exactly one exists it is updated; if more than one exists the command fails.

pingcli pingone populations apply [flags]

Examples

  # Create or update a population (body supplies name and optional description)
  pingcli pingone populations apply --environment-id <env-id> --from-file population.json

  # Read body from stdin
  pingcli pingone populations apply --environment-id <env-id> --from-file - < population.json

  # Create or update from flags, without --from-file
  pingcli pingone populations apply --environment-id <env-id> --name "My Population" --description "Standard users"

Options

  -e, --environment-id string             The PingOne environment ID
  -h, --help                              help for apply
  -f, --from-file string                  Path to a JSON file containing the request body, or "-" to read from stdin.
  -p, --population-id string              The population ID
      --alternative-identifier []string   Alternative identifiers for the population; repeatable or comma-separated
      --default                           Whether this is the default population for the environment
      --description string                The description of the population
      --name string                       The name of the population
      --password-policy-id string         ID of the password policy to associate with this population
      --preferred-language string         The default preferred language for members of this population

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