API error messages
Introduction
IntroductionAccess tokenACLApplication dependencyApplicationApplication tierArchive connectorArtifactCatalogCatalog item runChange 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
IntroductionaccesstokenaclaclentryactualparameterapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitionstringresulttagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseraccesstokenuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

Single sign-on for OpenID Connect

3 minute readReference

createOpenIDConnectConfiguration

Creates a new OpenID Connect configuration.

Arguments

Argument Name Type Description

clientId

String

(Required) Client ID used to uniquely identify the SDA server with the OIDC provider.

serverUrl

String

(Required) URL for the service host.

openIDConnectConfigurationName

String

(Required) The name of the OpenID Connect provider.

authorizationEndpoint

String

URL for the authorization end-point.

clientSecret

String

Secret used to request token ID for the authenticated used from the OIDC provider.

configurationUrl

String

The OpenID Connect provider’s well-known configuration endpoint. If specified, then the other end-points will be dynamically discovered when refreshConfiguration is set to true.

description

String

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

emailIdTokenClaim

String

Claim name in the token ID used to retrieve the user email.

enableSingleLogout

Boolean

Whether the user will be logged out from the OIDC provider when the user logs out of SDA.

enabled

Boolean

Whether this OpenID Connect configuration is enabled. Defaults to true.

fullUserNameIdTokenClaim

String

Claim name in the token ID used to retrieve the user full name.

jwkProviderEndpoint

String

URL for the JWK keys end-point.

logoutEndpoint

String

URL for the logout end-point.

refreshConfiguration

Boolean

Whether the endpoint attributes such as authorizationEndpoint, tokenEndpoint and other configuration details should be updated using the configurationURL. If true, then configurationURL must be set.

ssoProvider

SsoProvider

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

tokenEndpoint

String

URL for the token end-point.

userGroupsIdTokenClaim

String

Claim name in the token ID used to retrieve the groups that the user belongs to.

userNameIdTokenClaim

String

Claim name in the token ID used to retrieve the user name.

Positional arguments

clientId, serverUrl, openIDConnectConfigurationName

Usage

ec-perl

$cmdr->createOpenIDConnectConfiguration(<clientId>, <serverUrl>, <openIDConnectConfigurationName>, {<optionals>});
▼

ectool

ectool createOpenIDConnectConfiguration clientId,  serverUrl,  openIDConnectConfigurationName, [optionals]
▼

deleteOpenIDConnectConfiguration

Deletes an OpenID Connect configuration.

Arguments

Argument Name Type Description

openIDConnectConfigurationName

String

(Required) The name of the OpenID Connect provider.

Positional arguments

openIDConnectConfigurationName

Usage

ec-perl

$cmdr->deleteOpenIDConnectConfiguration(<openIDConnectConfigurationName>);
▼

ectool

ectool deleteOpenIDConnectConfiguration openIDConnectConfigurationName
▼

getOpenIDConnectConfiguration

Retrieves an OpenID Connect configuration by name.

Arguments

Argument Name Type Description

openIDConnectConfigurationName

String

(Required) The name of the OpenID Connect provider.

Positional arguments

openIDConnectConfigurationName

Usage

ec-perl

$cmdr->getOpenIDConnectConfiguration(<openIDConnectConfigurationName>);
▼

ectool

ectool getOpenIDConnectConfiguration openIDConnectConfigurationName
▼

getOpenIDConnectConfigurations

Retrieves all OpenID Connect configurations.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getOpenIDConnectConfigurations();
▼

ectool

ectool getOpenIDConnectConfigurations
▼

modifyOpenIDConnectConfiguration

Modifies an existing OpenID Connect configuration.

Arguments

Argument Name Type Description

clientId

String

(Required) Client ID used to uniquely identify the SDA server with the OIDC provider.

serverUrl

String

(Required) URL for the service host.

openIDConnectConfigurationName

String

(Required) The name of the OpenID Connect provider.

authorizationEndpoint

String

URL for the authorization end-point.

clientSecret

String

Secret used to request token ID for the authenticated used from the OIDC provider.

configurationUrl

String

The OpenID Connect provider’s well-known configuration endpoint. If specified, then the other end-points will be dynamically discovered when refreshConfiguration is set to true.

description

String

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

emailIdTokenClaim

String

Claim name in the token ID used to retrieve the user email.

enableSingleLogout

Boolean

Whether the user will be logged out from the OIDC provider when the user logs out of SDA.

enabled

Boolean

Whether this OpenID Connect configuration is enabled. Defaults to true.

fullUserNameIdTokenClaim

String

Claim name in the token ID used to retrieve the user full name.

jwkProviderEndpoint

String

URL for the JWK keys end-point.

logoutEndpoint

String

URL for the logout end-point.

newName

String

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

refreshConfiguration

Boolean

Whether the endpoint attributes such as authorizationEndpoint, tokenEndpoint and other configuration details should be updated using the configurationURL. If true, then configurationURL must be set.

ssoProvider

SsoProvider

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

tokenEndpoint

String

URL for the token end-point.

userGroupsIdTokenClaim

String

Claim name in the token ID used to retrieve the groups that the user belongs to.

userNameIdTokenClaim

String

Claim name in the token ID used to retrieve the user name.

Positional arguments

clientId, serverUrl, openIDConnectConfigurationName

Usage

ec-perl

$cmdr->modifyOpenIDConnectConfiguration(<clientId>, <serverUrl>, <openIDConnectConfigurationName>, {<optionals>});
▼

ectool

ectool modifyOpenIDConnectConfiguration clientId,  serverUrl,  openIDConnectConfigurationName, [optionals]
▼
Session
Single sign-on for SAML