detachCredential

Back to index

Summary

Detach a credential from an object.

projectName

Stringrequired

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

componentName

Stringoptional

The name of the component, if attaching a credential to a component, component process, or component process step.

credentialName

Stringrequired

The name of the credential.

applicationName

Stringoptional

The name of the application, if attaching a credential to an application process, or application process step.

applicationProjectName

Stringoptional

The name of the project containing specified application. If not specified, it is defaulted to the release project name.

catalogItemName

Stringoptional

The name of the catalog item, if attaching a credential to a catalog item.

catalogName

Stringoptional

The name of the catalog, if attaching a credential to a catalog.

deployerTaskName

Stringoptional

The name of the deployer task mapped to the deployer configuration.

gateType

Stringoptional

The type of the gate.

Possible values: "POST", "PRE"

microserviceName

Stringoptional

The name of the microservice, if attaching a credential to a microservice process.

pipelineName

Stringoptional

The name of the pipeline, if attaching a credential to a stage task.

procedureName

Stringoptional

The name of the procedure, if attaching a credential to a procedure or a procedure step.

processName

Stringoptional

The name of the process, if attaching a credential to a process or a process step.

processStepName

Stringoptional

The name of the process step, if attaching a credential to a process step.

releaseName

Stringoptional

The name of the release, if attaching a credential to a release.

scheduleName

Stringoptional

The name of the schedule, if attaching a credential to a schedule.

stageName

Stringoptional

The name of the stage, if attaching a credential to its task.

stateDefinitionName

Stringoptional

The name of the workflow state definition, if attaching a credential to a state definition.

stepName

Stringoptional

The name of the procedure step, if attaching a credential to a procedure step.

taskName

Stringoptional

The name of the task, if attaching a credential to a task.

triggerName

Stringoptional

The name of the trigger, if attaching a credential to a trigger.

workflowDefinitionName

Stringoptional

The name of the workflow, if attaching a credential to a state definition.

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*

ElectricFlow ef = new ElectricFlow()

def result = ef.detachCredential(
  projectName: "test-projectName",
  credentialName: "test-credentialName"
  /* optional arguments */
)▼