breakAclInheritance
Breaks access control list (ACL) inheritance at the specified object. When inheritance is broken, only the access control entries directly on the ACL will be considered. You must specify one or more of the following arguments (called locator arguments) to find the object where you want to break inheritance.
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
checkAccess
Checks access control list (ACL) permission information associated with an object for the current user, including inherited ACLs.
You must specify object locator arguments to define the object where you need to verify access.
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
createAclEntry
Creates an access control list entry (ACE) on an object for a given principal.
Arguments
Argument Name | Type | Description |
---|---|---|
principalType |
PrincipalType |
(Required) Type of principal for this access control entry (user or group). |
principalName |
String |
(Required) Name of the user or group for this access control entry. |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
changePermissionsPrivilege |
Access |
Determines whether the principal can modify access control for the object. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
executePrivilege |
Access |
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. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
modifyPrivilege |
Access |
Determines whether the principal can change the contents of the object. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
readPrivilege |
Access |
Determines whether the principal can examine the contents of the object. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
deleteAclEntry
Deletes an access control entry (ACE) in an access control list (ACL) on an object for a given principal (user or group).
Arguments
Argument Name | Type | Description |
---|---|---|
principalType |
PrincipalType |
(Required) Type of principal for this access control entry (user or group). |
principalName |
String |
(Required) Name of the user or group for this access control entry. |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
getAccess
Retrieves access control list (ACL) information associated with an object, including inherited ACLs.
You must specify object locators to find the object to which you need to verify access.
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
emulateRestoreInheritance |
Boolean |
Whether or not to include one level of broken inheritance if it exists. Used for emulating access if the lowest level of broken inheritance is restored. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
getAclEntry
Retrieves an access control entry (ACE) list on an object for a given principal.
You must specify a principalType
, principalName
, and an object locator to specify the ACE.
Arguments
Argument Name | Type | Description |
---|---|---|
principalType |
PrincipalType |
(Required) Type of principal for this access control entry (user or group). |
principalName |
String |
(Required) Name of the user or group for this access control entry. |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
modifyAclEntry
Modifies an ACE (access control entry) in an access control list (ACL) on an object for a given principal.
If a privilege is not specified, an object inherits it from its parent object ACL. |
You must specify principalType
, principalName
, and object locator arguments to identify the target ACL.
Arguments
Argument Name | Type | Description |
---|---|---|
principalType |
PrincipalType |
(Required) Type of principal for this access control entry (user or group). |
principalName |
String |
(Required) Name of the user or group for this access control entry. |
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
changePermissionsPrivilege |
Access |
Determines whether the principal can modify access control for the object. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
executePrivilege |
Access |
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. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
modifyPrivilege |
Access |
Determines whether the principal can change the contents of the object. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
readPrivilege |
Access |
Determines whether the principal can examine the contents of the object. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |
restoreAclInheritance
Restores the access control list (ACL) inheritance for the specified object.
You must use object locators to specify the object where you want to restore ACL inheritance. |
Arguments
Argument Name | Type | Description |
---|---|---|
applicationName |
String |
The name of the application container of the property sheet that owns the property. |
applicationTierName |
String |
The name of the application tier container of the property sheet that owns the property. |
archiveConnectorName |
String |
The name of the archive connector of the property sheet that owns the property. |
artifactName |
String |
The name of the artifact container of the property sheet that owns the property. |
artifactVersionName |
String |
The name of the artifactVersion container of the property sheet that owns the property. |
catalogItemRunId |
String |
The primary key of the CatalogItemRun container of the property sheet that owns the property. |
catalogName |
String |
The name of the catalog of the property sheet that owns the property. |
ciBuildDetailName |
String |
The name of the CI build detail of the property sheet that owns the property. |
ciConfigurationName |
String |
The name of the CI Configuration. |
clusterName |
String |
The name of the cluster which owns property sheet. |
componentName |
String |
The name of the component container of the property sheet that owns the property. |
configName |
String |
The name of the emailConfig container that owns the property. |
credentialName |
String |
The name of the credential container of the property sheet that owns the property. |
credentialProviderName |
String |
Unique name of the credential provider within the project. |
dashboardName |
String |
The name of the dashboard of the property sheet that owns the property. |
dataRetentionPolicyName |
String |
The name of the data retention policy of the property sheet that owns the property. |
environmentName |
String |
The name of the environment container of the property sheet that owns the property. |
environmentTemplateName |
String |
The name of the environment template container of the property sheet that owns the property. |
environmentTemplateTierName |
String |
The name of the environment template tier container of the property sheet that owns the property. |
environmentTierName |
String |
The name of the environment tier container of the property sheet that owns the property. |
flowName |
String |
The name of the flow container of the property sheet that owns the property. |
flowRuntimeId |
String |
The primary key or name of the flowRuntime container of the property sheet that owns the property. |
flowRuntimeName |
String |
The name of the flow runtime container of the property sheet that owns the property. |
flowRuntimeStateId |
String |
The primary key or name of the flowRuntimeState container of the property sheet that owns the property. |
flowRuntimeStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowStateName |
String |
The name of the flow state container of the property sheet that owns the property. |
flowTransitionName |
String |
The name of the flow transition container of the property sheet that owns the property. |
gateType |
GateType |
The type of the gate which owns property sheet. |
gatewayName |
String |
The name of the gateway container of the property sheet. |
groupName |
String |
The name of the group container of the property sheet that owns the property. |
jobId |
String |
The primary key or name of the job container of the property sheet that owns the property. |
jobStepId |
UUID |
The primary key of the job-step container of the property sheet that owns the property. |
kerberosKeytabName |
String |
The name of the kerberos keytab. |
microserviceName |
String |
The name of the microservice container of the property sheet. |
notifierName |
String |
The name of the notifier container of the property sheet that owns the property. |
objectId |
String |
The object ID as returned by FindObjects. |
objectType |
String |
The type of object protected by the access control. |
path |
String |
Property path string. |
personaName |
String |
The name of the persona. |
pipelineName |
String |
The name of the pipeline container of the property sheet that owns the property. |
pluginConfigurationName |
String |
The name of the plugin configuration container of the property sheet that owns the property. |
pluginName |
String |
The name of the plugin container of the property sheet that owns the property. |
procedureName |
String |
The name of the procedure container of the property sheet that owns the property. |
processName |
String |
The name of the process, if the container is a process or process step. |
processStepName |
String |
The name of the process step, if the container is a process step. |
projectName |
String |
The name of the project container of the property sheet that owns the property. |
propertySheetId |
UUID |
The primary key of the property sheet that owns the property. |
releaseName |
String |
The name of the release container of the property sheet that owns the property. |
reportName |
String |
The name of the report of the property sheet that owns the property. |
reportObjectTypeName |
String |
The name of the report object type of the property sheet that owns the property. |
repositoryName |
String |
The name of the repository container of the property sheet that owns the property. |
resourceName |
String |
The name of the resource container of the property sheet that owns the property. |
resourcePoolName |
String |
The name of the resource pool container of the property sheet that owns the property. |
resourceTemplateName |
String |
The name of the resource template container of the property sheet that owns the property. |
scheduleName |
String |
The name of the schedule container of the property sheet. |
scmSyncName |
String |
The name of the SCM Sync container of the property sheet that owns the property. |
searchFilterName |
String |
The name of the search filter container of the property sheet. |
serviceAccountName |
String |
Retrieves the name of the service account container of the property sheet. |
snapshotName |
String |
The name of the snapshot container of the property sheet that owns the property. |
stageName |
String |
The name of the stage container of the property sheet that owns the property. |
stateDefinitionName |
String |
The name of the state definition container of the property sheet that owns the property. |
stateName |
String |
The name of the state container of the property sheet that owns the property. |
stepName |
String |
The name of the step container of the property sheet that owns the property. |
systemObjectName |
SystemObjectName |
The system object. |
tagName |
String |
The name of the tag. |
taskName |
String |
The name of the task which owns property sheet. |
transitionDefinitionName |
String |
The name of the transition definition container of the property sheet that owns the property. |
transitionName |
String |
The name of the transition container of the property sheet that owns the property. |
triggerName |
String |
The name of the trigger which owns property sheet. |
userName |
String |
The name of the user container of the property sheet that owns the property. |
widgetName |
String |
The name of the widget of the property sheet that owns the property. |
workflowDefinitionName |
String |
The name of the workflow definition container of the property sheet that owns the property. |
workflowName |
String |
The name of the workflow container of the property sheet that owns the property. |
workspaceName |
String |
The name of the workspace container of the property sheet. |
zoneName |
String |
The name of the zone container of the property sheet. |