Using the Perl API
Perl API response and element glossary
IntroductionACL managementApplication dependencyApplicationsApplication tierArtifact managementCatalogsChange historyCI Build detailCI configurationCI JobsComponentsCredential managementCustom filtersDatabase configurationData retentionDevOps insightDirectory Provider managementDynamic environmentsemail configuration managementEmail Notifier managementEnvironmentEnvironment tierGateway and Zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementServer managementSingle sign-onSnapshotsTier mapUser and Group managementWait dependenciesWebhhook managementWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
IntroductionExamples
Introductionaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationservicemappingapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuilddetailciconfigurationclustercomponentcontainercredentialdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeployerservicedeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmentmapenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvironmentvariableenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparameterpersonapersonacategorypersonapagepipelinepluginportprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulesearchfilterserverserviceaccountserviceserviceclustermappingservicedependencyservicemapdetailsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitionuserutilityresourcewaitdependencywidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezone

SamlIdentityProvider

2 minute readReference

createSamlIdentityProvider

Create a new SAML Identity Provider

Arguments

Argument Name Type Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

colorCode

String

Color code to be associate with the IDP

description

String

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

enabled

Boolean

If true, enables SAML Identity Provider

label

String

Label used by UI to display the text (e.g. label for UI button)

metadata

String

The metadata of the SAML identity provider

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName'
                /* optional arguments */)
▼

deleteSamlIdentityProvider

Deletes a SAML Identity Provider

Arguments

Argument Name Type Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName')
▼

getSamlIdentityProvider

Retrieve a SAML Identity Provider by name

Arguments

Argument Name Type Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName')
▼

getSamlIdentityProviders

Retrieve all SAML Identity Providers

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlIdentityProviders()
▼

modifySamlIdentityProvider

Modify an existing SAML Identity Provider

Arguments

Argument Name Type Description

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

colorCode

String

Color code to be associate with the IDP

description

String

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

enabled

Boolean

If true, enables SAML Identity Provider

label

String

Label used by UI to display the text (e.g. label for UI button)

metadata

String

The metadata of the SAML identity provider

newName

String

New name for an existing object that is being renamed.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifySamlIdentityProvider(
                samlIdentityProviderName: 'test-samlIdentityProviderName'
                /* optional arguments */)
▼
rundiscovery
samlserviceprovider