Flow API guide
IntroductionRoadmap to CloudBees Flow APIsUsing the CloudBees Flow Perl APICloudBees Flow Perl API Response and Element GlossaryUsing the CloudBees Flow RESTful APIUsing the Flow DSLUsing the CloudBees Flow Groovy APIUsing JRubyCloudBees Flow Error MessagesCloudBees Flow Perl API Response and Element Glossary
Perl API Commands
IntroductionACL ManagementApplication DependencyApplicationsApplication Tier Artifact ManagementCatalogsChange HistoryComponentsCredential 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
Groovy API guide
IntroductionExamples
Groovy API commands
Introductionaclaclentryactualparameteractualparametersappdepapplicationappservicemappingapptierarchiveconnectorartifactartifactversioncatalogcatalogitemclustercomponentcontainercredentialdashboarddashboardcolumndataretentiondeployerappdeployerconfdeployerservicedeployhistorydirproviderdoisdatasourceemailconfigemailnotifierentitychangeenvinvenvironmentenvmapenvtemeplateenvtemptierenvtemptiermapenvtemptiermappingenvtemptierresourcemappingenvtierenvvareventsubflowruntimeformaloutparamformalparamgategatewaygrouphookjobjobstepkerberoskeytablicensenoteobjectoutputparampersonapersonacatpersonapagepipelinepipelinerunnamepluginportprocdependprocedureprocessprocstepprojectpropertyreleasereportreportfilterreportobjassocreportobjattrreportobjtyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartrollingrundiscoverysamlidentitysamlserviceschedulesearchfilterserverserviceserviceacctserviceclusterservicedepservicemapsessionsnapshotstagestatestatedeftagtasktiermaptiermappingtransdeftransitionuserutilitywaitdependwidgetwidgetfilteroverrideworkdefworkflowworkitemworkspacezone
Groovy API argument models

SamlIdentityProvider commands

2 minute readReference

createSamlIdentityProvider

Create a new SAML Identity Provider

Arguments

Argument NameTypeDescription

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 Flow.

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

deleteSamlIdentityProvider

Deletes a SAML Identity Provider

Arguments

Argument NameTypeDescription

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getSamlIdentityProvider

Retrieve a SAML Identity Provider by name

Arguments

Argument NameTypeDescription

samlIdentityProviderName

String

The name of the SAML Identity Provider (Required)

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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

getSamlIdentityProviders

Retrieve all SAML Identity Providers

Arguments

Usage

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlIdentityProviders()

modifySamlIdentityProvider

Modify an existing SAML Identity Provider

Arguments

Argument NameTypeDescription

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 Flow.

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

Groovy

import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.apis.model.*


ElectricFlow ef = new ElectricFlow()

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