Configuration Automation - Ping CLI

pingcli pingone agreements apply

Create or update an agreement

Synopsis

Idempotently create or update an agreement looked up by the "name" field in the JSON body within the supplied --environment-id. If no agreement 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 agreements apply [flags]

Examples

  # Create or update an agreement (body supplies name, enabled, and optional description)
  pingcli pingone agreements apply --environment-id <env-id> --from-file agreement.json

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

  # Create or update from flags, without --from-file
  pingcli pingone agreements apply --environment-id <env-id> --name "Terms of Service" --enabled=true

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.
  -i, --agreement-id string             The agreement ID
      --description string              Description of the agreement
      --enabled                         Whether the agreement is active and presented to users
      --name string                     Display name of the agreement
      --reconsent-period-days float64   Number of days after initial consent after which users must reconsent

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