API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogChange historyCI buildCI build detailCI configurationCI eventCI jobClusterComponentsCredentialCredential providerCustom filterDashboardDashboard columnDatabase configurationData retention policyDeployer applicationDevOps Insight data sourceDirectory providerDynamic environmentEmail configurationEmail notifierEnvironmentEnvironment tierGatewayGroupInstalling or upgrading remote agentsJobKerberos keytabMicroserviceMicroservice mappingMiscellaneousObjectObject tagsParameterPersonaPipelinePluginPlugin configurationPlugin catalogProcedureProcessProcess dependencyProcess stepProjectPropertyReleaseReportReporting filterReport object associationReport object attributeReport object typeResourceRolling deployScheduleSCM syncServerServer settings categoryService accounts for webhooksSessionSingle sign-on for OpenID ConnectSingle sign-on for SAMLSnapshotsTier mapTriggerUserUser emailUtility resourceWait dependencyWebhook resultWidgetWidget filter overrideWorkflowWorkflow definitionWork itemsWorkspaceZone
Perl API response and element glossary
Introduction
Examples
Troubleshooting
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcibuildcibuilddetailciconfigurationcieventclustercompliancecomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

SamlServiceProvider

2 minute readReference

createSamlServiceProvider

Creates a new SAML service provider.

Arguments

Argument Name Type Description

entityId

String

Service provider entity ID (usually URI).(Required)

serverUrl

String

URL for the service provider host.(Required)

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned=true/false in descriptor.

digestAlgorithm

String

SAML digest algorithm.

enabled

Boolean

If true, enables SAML service provider.

groupClaimAttribute

String

Security group claim attribute in the SAML response that contains the user groups.

mdSigningEnabled

Boolean

If true, sign service provider metadata.

mdSigningPassphrase

String

Passphrase use for service provider metadata signing private key.

mdSigningPrivateKey

String

Service provider metadata signing private key.

mdSigningPublicCertificate

String

Service provider metadata signing public certificate.

nameIdFormat

String

NameID format such as urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.

passphrase

String

Passphrase use for service provider private key.

privateKey

String

Service provider private key.

publicCertificate

String

Service provider’s public certificate.

samlServiceProviderName

String

The name of the SAML service provider.

signatureAlgorithm

String

SAML signature algorithm.

userEmailAttribute

String

The mapping for the user email attribute in the SAML response.

userFullNameAttribute

String

The mapping for the full user name attribute in the SAML response.

wantAssertionsSigned

Boolean

Metadata will have WantAssertionsSigned=true/false in descriptor.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createSamlServiceProvider(
                entityId: 'test-entityId',
                serverUrl: 'test-serverUrl'
                /* optional arguments */)

deleteSamlServiceProvider

Deletes a SAML service provider.

Arguments

Argument Name Type Description

samlServiceProviderName

String

The name of the SAML service provider.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteSamlServiceProvider()

getSamlServiceProvider

Retrieves a SAML service provider by name.

Arguments

Argument Name Type Description

samlServiceProviderName

String

The name of the SAML service provider.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProvider()

getSamlServiceProviderMetadata

Retrieves SAML identity provider metadata.

Arguments

Argument Name Type Description

downloadCertificateOnly

Boolean

Service provider Certificate file will be available to downloaded.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProviderMetadata(
                /* optional arguments */)

getSamlServiceProviders

Retrieves all SAML service providers.

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getSamlServiceProviders()

modifySamlServiceProvider

Modifies an existing SAML service provider.

Arguments

Argument Name Type Description

entityId

String

Service provider entity ID (usually URI).(Required)

serverUrl

String

URL for the service provider host.(Required)

samlServiceProviderName

String

The name of the SAML service provider.

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned=true/false in descriptor.

digestAlgorithm

String

SAML digest algorithm.

enabled

Boolean

If true, enables SAML service provider.

groupClaimAttribute

String

Security group claim attribute in the SAML response that contains the user groups.

mdSigningEnabled

Boolean

If true, sign service provider metadata.

mdSigningPassphrase

String

Passphrase use for service provider metadata signing private key.

mdSigningPrivateKey

String

Service provider metadata signing private key.

mdSigningPublicCertificate

String

Service provider metadata signing public certificate.

nameIdFormat

String

NameID format such as urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified.

passphrase

String

Passphrase use for service provider private key.

privateKey

String

Service provider private key.

publicCertificate

String

Service provider’s public certificate.

signatureAlgorithm

String

SAML signature algorithm.

userEmailAttribute

String

The mapping for the user email attribute in the SAML response.

userFullNameAttribute

String

The mapping for the full user name attribute in the SAML response.

wantAssertionsSigned

Boolean

Metadata will have WantAssertionsSigned=true/false in descriptor.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifySamlServiceProvider(
                entityId: 'test-entityId',
                serverUrl: 'test-serverUrl'
                /* optional arguments */)
samlidentityprovider
schedule