The name of the application container of the property sheet that owns the property.

applicationName

The name of the application tier container of the property sheet that owns the property.

applicationTierName

The name of the archive connector of the property sheet that owns the property.

archiveConnectorName

The name of the artifact container of the property sheet that owns the property.

artifactName

The name of the artifactVersion container of the property sheet that owns the property.

artifactVersionName

The primary key of the CatalogItemRun container of the property sheet that owns the property.

catalogItemRunId

The name of the catalog of the property sheet that owns the property.

catalogName

The name of the CI build detail of the property sheet that owns the property.

ciBuildDetailName

ciConfigurationName

The name of the cluster which owns property sheet.

clusterName

The name of the component container of the property sheet that owns the property.

componentName

The name of the emailConfig container that owns the property.

configName

The name of the credential container of the property sheet that owns the property.

credentialName

Unique name of the credential provider within the project.

credentialProviderName

The name of the dashboard of the property sheet that owns the property.

dashboardName

The name of the data retention policy of the property sheet that owns the property.

dataRetentionPolicyName

The name of the environment container of the property sheet that owns the property.

environmentName

The name of the environment template container of the property sheet that owns the property.

environmentTemplateName

The name of the environment template tier container of the property sheet that owns the property.

environmentTemplateTierName

The name of the environment tier container of the property sheet that owns the property.

environmentTierName

The name of the flow container of the property sheet that owns the property.

flowName

The primary key or name of the flowRuntime container of the property sheet that owns the property.

flowRuntimeId

The name of the flow runtime container of the property sheet that owns the property.

flowRuntimeName

The primary key or name of the flowRuntimeState container of the property sheet that owns the property.

flowRuntimeStateId

The name of the flow state container of the property sheet that owns the property.

flowRuntimeStateName

flowStateName

The name of the flow transition container of the property sheet that owns the property.

flowTransitionName

The type of the gate which owns property sheet.

gateType

The name of the gateway container of the property sheet.

gatewayName

The name of the group container of the property sheet that owns the property.

groupName

The primary key or name of the job container of the property sheet that owns the property.

jobId

The primary key of the job-step container of the property sheet that owns the property.

jobStepId

The name of the microservice container of the property sheet.

microserviceName

The name of the notifier container of the property sheet that owns the property.

notifierName

The object ID as returned by FindObjects.

objectId

The type of object protected by the access control.

objectType

path

personaName

The name of the pipeline container of the property sheet that owns the property.

pipelineName

The name of the plugin configuration container of the property sheet that owns the property.

pluginConfigurationName

The name of the plugin container of the property sheet that owns the property.

pluginName

The name of the procedure container of the property sheet that owns the property.

procedureName

The name of the process, if the container is a process or process step.

processName

The name of the process step, if the container is a process step.

processStepName

The name of the project container of the property sheet that owns the property.

projectName

The primary key of the property sheet that owns the property.

propertySheetId

The name of the release container of the property sheet that owns the property.

releaseName

The name of the report of the property sheet that owns the property.

reportName

The name of the report object type of the property sheet that owns the property.

reportObjectTypeName

The name of the repository container of the property sheet that owns the property.

repositoryName

The name of the resource container of the property sheet that owns the property.

resourceName

The name of the resource pool container of the property sheet that owns the property.

resourcePoolName

The name of the resource template container of the property sheet that owns the property.

resourceTemplateName

The name of the schedule container of the property sheet.

scheduleName

The name of the SCM Sync container of the property sheet that owns the property.

scmSyncName

The name of the search filter container of the property sheet.

searchFilterName

Retrieves the name of the service account container of the property sheet.

serviceAccountName

The name of the snapshot container of the property sheet that owns the property.

snapshotName

The name of the stage container of the property sheet that owns the property.

stageName

The name of the state definition container of the property sheet that owns the property.

stateDefinitionName

The name of the state container of the property sheet that owns the property.

stateName

The name of the step container of the property sheet that owns the property.

stepName

systemObjectName

tagName

The name of the task which owns property sheet.

taskName

The name of the transition definition container of the property sheet that owns the property.

transitionDefinitionName

The name of the transition container of the property sheet that owns the property.

transitionName

The name of the trigger which owns property sheet.

triggerName

The name of the user container of the property sheet that owns the property.

userName

The name of the widget of the property sheet that owns the property.

widgetName

The name of the workflow definition container of the property sheet that owns the property.

workflowDefinitionName

The name of the workflow container of the property sheet that owns the property.

workflowName

The name of the workspace container of the property sheet.

workspaceName

The name of the zone container of the property sheet.

zoneName

An access control list; controls access to domain objects.

aclEntry

Name of the user or group for this access control entry.

principalName

Type of principal for this access control entry (user or group).

principalType

Determines whether the principal can modify access control for the object.

changePermissionsPrivilege

Determines whether the principal can invoke this object as part of a job; this privilege is only relevant for a few objects such as procedures and procedure steps.

executePrivilege

Determines whether the principal can change the contents of the object.

modifyPrivilege

Determines whether the principal can examine the contents of the object.

readPrivilege

An individual access control list entry; allows or denies a privilege on a domain object.

actualParameter

The name of the parameter to create/modify/delete.

actualParameterName

The name for the project that must be unique among all projects.

The name of the application, if the actual parameter is on an application process step.

catalogItemName

The ID of the catalog item run, if the actual parameter is on a catalog item run.

The name of the component, if the actual parameter is on a component process step.

The name of the flow to which the flow state belongs to.

The name of the flow state, if the formal parameter is on a flow state.

The new name for an existing object that is being renamed.

newName

The name of the process, if the actual parameter is on a process step.

The name of the process step, if the actual parameter is on a process step.

The name of the release, if the actual parameter is on a release.

tierMapName

The value of the actual parameter, if creating or modifying.

value

A name/value pair that is passed to a procedure when it is invoked.

addCredential

Unique name of the plugin configuration within the project.

Name of the credential provider where the credential secret is stored.

Name of the credential provider project, if different from the credential project.

credentialProviderProjectName

credentialType

Comment text describing this object that is not interpreted at all by CloudBees CD/RO.

description

The password for the credential. Can also be a certificate or any other chunk of data.

password

If true, recovering the password by invoking getFullCredential from a job step is allowed.

passwordRecoveryAllowed

pluginKey

pluginProjectName

Name of the folder where the password is stored.

secretPath

Applicable if credentialProviderName is specified. Whether to test that the credential exists in the secret management system prior to saving. Defaults to true.

test

Applicable for `cyberark ccp` provider type. This property identifies two identically provisioned accounts in a dual accounts pair under one virtual username.

virtualUserName

A username/password stored in the server as encrypted data. Typically used in an agent context to authenticate with a third-party system. The password is not available in the web context for security reasons, so this object has no getPassword method.

analyticsServerConfiguration

CloudBees CD/RO server communicates with the Analytics server using this URL. This URL must be set if Analytics is enabled. If using an IPv6 address, enclose the address in square brackets. Example: `[<IPv6-ADDRESS>]`.

cluster

Summary

clusterName

projectName

definitionParameters

description

environmentName

newName

pluginConfigurationName

pluginKey

pluginProjectName

providerClusterName

providerProjectName

provisionParameters

provisionProcedure

Usage