PingOne Platform APIs

Variable declarations

Before you can declare a variable (POST {{apiPath}}/v1/environments/{{envID}}/promotionVariableDeclarations), you need to define the variable that you intend to use. The declaration associates the variable defined with the correct attributes for the resource used for the promotion. See Variable Definitions for more information.

When creating or updating promotion variable declarations, if the bound resource attribute is classified as sensitive (such as for client secrets or passwords), the associated variable definition in the target environment must also be marked as sensitive (the isSensitive attribute set to true). If it is not, the request fails with a validation error.

Variable declarations data model

Property Type Required Mutable Description

createdAt

Date

N/A

Read-only

The date and time at which the resource was created (ISO 8601 format).

resource

Object

Required

Mutable

Contains the UUID of the configuration resource.

resource.category

String

Required

Mutable

The category of the configuration resource.

resource.id

String

Required

Mutable

The UUID of the configuration resource.

resource.name

String

Required

Mutable

The name of the configuration resource.

targetEnvironmentMissingVariableDefinitions

String[]

Optional

Mutable

The list of variable definitions that are missing in the target environment.

updatedAt

Date

N/A

Read-only

The date and time at which the resource was last updated (ISO 8601 format).

variables

Map

Required

Mutable

A mapping of configuration resource properties to the name values of defined variables. Each value must use the format ${promotionVariable: name} where name is a valid variable name. Each key must be an updatable attribute for the resource category. This Map cannot be empty.