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

Single sign-on for SAML

3 minute readReference

createSamlIdentityProvider

Creates a new SAML identity provider.

Arguments

Argument Name Type Description

samlIdentityProviderName

String

(Required) The name of the SAML Identity Provider.

colorCode

String

DEPRECATED: Color code to be associated with the IDP.

description

String

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

enabled

Boolean

If true, enables SAML Identity Provider.

label

String

DEPRECATED: Label used by the UI to display the text. For example, a label for a UI button.

metadata

String

The metadata of the SAML identity provider.

ssoProvider

SsoProvider

Used to identify the SSO provider for displaying the branded SSO button on the login page.

Positional arguments

samlIdentityProviderName

Usage

ec-perl

$cmdr->createSamlIdentityProvider(<samlIdentityProviderName>, {<optionals>});
▼

ectool

ectool createSamlIdentityProvider samlIdentityProviderName [optionals]
▼

createSamlServiceProvider

Creates a new SAML service provider.

Arguments

Argument Name Type Description

entityId

String

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

serverUrl

String

(Required) URL for the service provider host.

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned=true/false in descriptor.

digestAlgorithm

SamlDigestAlgorithm

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

SamlSignatureAlgorithm

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.

Positional arguments

entityId, serverUrl

Usage

ec-perl

$cmdr->createSamlServiceProvider(<entityId>, <serverUrl>, {<optionals>});
▼

ectool

ectool createSamlServiceProvider entityId serverUrl [optionals]
▼

deleteSamlIdentityProvider

Deletes a SAML identity provider.

Arguments

Argument Name Type Description

samlIdentityProviderName

String

(Required) The name of the SAML Identity Provider.

Positional arguments

samlIdentityProviderName

Usage

ec-perl

$cmdr->deleteSamlIdentityProvider(<samlIdentityProviderName>);
▼

ectool

ectool deleteSamlIdentityProvider samlIdentityProviderName
▼

deleteSamlServiceProvider

Deletes a SAML service provider.

Arguments

Argument Name Type Description

samlServiceProviderName

String

The name of the SAML service provider.

Positional arguments

None.

Usage

ec-perl

$cmdr->deleteSamlServiceProvider({<optionals>});
▼

ectool

ectool deleteSamlServiceProvider [optionals]
▼

getSamlIdentityProvider

Retrieves a SAML identity provider by name.

Arguments

Argument Name Type Description

samlIdentityProviderName

String

(Required) The name of the SAML Identity Provider.

Positional arguments

samlIdentityProviderName

Usage

ec-perl

$cmdr->getSamlIdentityProvider(<samlIdentityProviderName>);
▼

ectool

ectool getSamlIdentityProvider samlIdentityProviderName
▼

getSamlIdentityProviders

Retrieves all SAML identity providers.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getSamlIdentityProviders();
▼

ectool

ectool getSamlIdentityProviders
▼

getSamlServiceProvider

Retrieves a SAML service provider by name.

Arguments

Argument Name Type Description

samlServiceProviderName

String

The name of the SAML service provider.

Positional arguments

None.

Usage

ec-perl

$cmdr->getSamlServiceProvider({<optionals>});
▼

ectool

ectool getSamlServiceProvider [optionals]
▼

getSamlServiceProviderMetadata

Retrieves SAML identity provider metadata.

Arguments

Argument Name Type Description

downloadCertificateOnly

Boolean

Service provider Certificate file will be available to downloaded.

Positional arguments

None.

Usage

ec-perl

$cmdr->getSamlServiceProviderMetadata({<optionals>});
▼

ectool

ectool getSamlServiceProviderMetadata [optionals]
▼

getSamlServiceProviders

Retrieves all SAML service providers.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getSamlServiceProviders();
▼

ectool

ectool getSamlServiceProviders
▼

modifySamlIdentityProvider

Modifies an existing SAML identity provider.

Arguments

Argument Name Type Description

samlIdentityProviderName

String

(Required) The name of the SAML Identity Provider.

colorCode

String

DEPRECATED: Color code to be associated with the IDP.

description

String

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

enabled

Boolean

If true, enables SAML Identity Provider.

label

String

DEPRECATED: Label used by the UI to display the text. For example, a label for a UI button.

metadata

String

The metadata of the SAML identity provider.

newName

String

The new name for an existing object that is being renamed.

ssoProvider

SsoProvider

Used to identify the SSO provider for displaying the branded SSO button on the login page.

Positional arguments

samlIdentityProviderName

Usage

ec-perl

$cmdr->modifySamlIdentityProvider(<samlIdentityProviderName>, {<optionals>});
▼

ectool

ectool modifySamlIdentityProvider samlIdentityProviderName [optionals]
▼

modifySamlServiceProvider

Modifies an existing SAML service provider.

Arguments

Argument Name Type Description

entityId

String

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

serverUrl

String

(Required) URL for the service provider host.

authnRequestsSigned

Boolean

Metadata will have AuthnRequestsSigned=true/false in descriptor.

digestAlgorithm

SamlDigestAlgorithm

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

SamlSignatureAlgorithm

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.

Positional arguments

entityId, serverUrl

Usage

ec-perl

$cmdr->modifySamlServiceProvider(<entityId>, <serverUrl>, {<optionals>});
▼

ectool

ectool modifySamlServiceProvider entityId serverUrl [optionals]
▼
Single sign-on for OpenID Connect
Snapshots