--- title: Environment and Configuration Variables description: The pingctl utility referenced here has been deprecated and is no longer being maintained. It is recommended to use the Ping CLI utility under active development and support be used instead. component: devops page_id: devops::get-started/configVars canonical_url: https://developer.pingidentity.com/devops/get-started/configVars.html section_ids: deprecation-notice-september-2025: Deprecation Notice September 2025 devops-pingone-variables: PingOne Variables devops-pingctl-variables: pingctl Variables devops-pingctl_output_columns: PINGCTL_OUTPUT_COLUMNS devops-pingctl_output_sort: PINGCTL_OUTPUT_SORT --- # Environment and Configuration Variables ## Deprecation Notice September 2025 | | | | - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | The `pingctl` utility referenced here has been deprecated and is no longer being maintained. It is recommended to use the [Ping CLI](https://developer.pingidentity.com/pingcli/pingcli_landing_page.html) utility under active development and support be used instead.With few exceptions, many `pingctl` commands can be replicated using the `pingcli` utility, with gaps being addressed based on prioritization. | Configuration and environment variables allow users to cache secure and repetitive settings into a `pingctl` config file. The default location of the file is `~/.pingidentity/config`. You can specify a given configuration item in one of three ways: the `pingctl` config file, the user's current environment variables, or through command line arguments. The order of priority (highest to lowest) is: * Command-Line argument overrides (when available) * `pingctl` config file * Environment variable overrides ## PingOne Variables The standard **PingOne variables** used by `pingctl` are as follows: | Variable | Description | | ---------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------- | | **PINGONE\_API\_URL** | [PingOne API URL](https://apidocs.pingidentity.com/pingone/platform/v1/api/#get-read-external-authentication-status) (i.e. api.pingone.com/v1) | | **PINGONE\_AUTH\_URL** | [PingOne Auth URL](https://apidocs.pingidentity.com/pingone/platform/v1/api/#changelog) (i.e. auth.pingone.com, auth.pingone.eu, auth.pingone.asia) | | **PINGONE\_ENVIRONMENT\_ID** | PingOne Environment ID GUID | | **PINGONE\_WORKER\_APP\_CLIENT\_ID** | PingOne Worker App ID GUID with access to PingOne Environment | | **PINGONE\_WORKER\_APP\_GRANT\_TYPE** | PingOne Worker App Grant Type to use. Should be one of authorization\_code, implicit or client\_credential | | **PINGONE\_WORKER\_APP\_REDIRECT\_URI** | PingOne Worker App available redirect\_uri. Defaults to http\://localhost:8000 | | **PINGONE\_WORKER\_APP\_CLIENT\_SECRET** | PingOne Worker App Secret providing authentication to PingOne Worker App ID GUID | ## pingctl Variables | Variable | Description | | ---------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------- | | **PING\_IDENTITY\_ACCEPT\_EULA** | Specify `YES` or `NO` to accept [Ping Identity EULA](https://www.pingidentity.com/en/legal/subscription-agreement.html) | | **PING\_IDENTITY\_DEVOPS\_USER** | [Ping DevOps User](https://devops.pingidentity.com/how-to/devopsRegistration/) | | **PING\_IDENTITY\_DEVOPS\_KEY** | [Ping DevOps Key](https://devops.pingidentity.com/how-to/devopsRegistration/) | | **PING\_IDENTITY\_DEVOPS\_HOME** | Home directory/path of your DevOps projects | | **PING\_IDENTITY\_DEVOPS\_REGISTRY** | Default Docker registry from which to pull images | | **PING\_IDENTITY\_DEVOPS\_TAG** | Default DevOps tag to use for deployments (i.e. 2509) | | **PINGCTL\_CONFIG** | Location of the `pingctl` configuration file. Set as an environment variable only. Default: `~/.pingidentity/config` | | **PINGCTL\_DEFAULT\_OUTPUT** | Specifies default format of data returned. Command-Line arg `-o`. Default: `table` | | **PINGCTL\_DEFAULT\_POPULATION** | Specifies default population to use for PingOne commands. Command-Line arg `-p`. Default: `Default` | | **PINGCTL\_OUTPUT\_COLUMNS\_{resource\_type}** | Specify custom format of table csv data to be returned. Command-Line arg `-c`. See more detail [below](#devops-pingctl_output_columns) | | **PINGCTL\_OUTPUT\_SORT\_{resource\_type}** | Specify column to use for sorting data. Command-Line arg `-s`. See more detail [below](#devops-pingctl_output_sort) | ## PINGCTL\_OUTPUT\_COLUMNS There are two classes of variables provided by `PINGCTL_OUTPUT`: * `PINGCTL_OUTPUT_COLUMNS_{resource}` - Specifies the columns to display whenever a `pingctl pingone get {resource}` command is used. Same as the `-c` option on the command-line (see [pingctl pingone get](../tools/commands/pingone.html) command). Format of value should be constructed with `HeadingName:jsonName,HeadingName:jsonName`. The best way to understand is by looking at the example of the default `USERS` resource: | | | | - | ------------------------------------------------------------------------ | | | `PINGCTL_OUTPUT_COLUMNS_USERS=LastName:name.family,FirstName:name.given` | Setting the above will generate output similar to: ```shell $ pingctl pingone get users LastName FirstName -------- --------- Badham Antonik Agnès Enterle -- 2 'USERS' returned ``` Alternatively, you can use the `-c` option as a command-line argument: ```shell $ pingctl pingone get users -c "LastName:name.family,FirstName:name.given,Username:username" LastName FirstName Username -------- --------- -------- Badham Antonik antonik_adham Agnès Enterle enterle_agnès -- 2 'USERS' returned ``` ## PINGCTL\_OUTPUT\_SORT * `PINGCTL_OUTPUT_SORT_{resource}` - specifies the column on which to sort. Same as the `-s` option on the command-line (see [pingctl pingone get](../tools/commands/pingone.html) command). Format of the value should be constructed with `jsonName`. The name must be one of the entries in `PINGCTL_OUTPUT_COLUMNS_{resource}`. | | | | - | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | | ```shell PINGCTL_OUTPUT_SORT_USERS=name.family ```Setting the above will generate output similar to the following (note that the LastName (name.family) is sorted):```shell $ pingctl pingone get users LastName FirstName -------- --------- Agnès Enterle Badham Antonik -- 2 'USERS' returned ```Alternatively, you can use the `-s` option as a command-line argument:```shell $ pingctl pingone get users -s "name.given" LastName FirstName Username -------- --------- -------- Agnès Enterle enterle_agnès Badham Antonik antonik_badham -- 2 'USERS' returned ``` |