Using the Perl API
IntroductionAccess tokensACL managementApplication dependencyApplicationsApplication tier Artifact managementCatalogsChange historyCI build detailCI configurationCI jobsComponentsCredential managementCustom filtersDatabase configurationData retentionCloudBees AnalyticsDirectory provider managementDynamic environmentsEmail configuration managementEmail notifier managementEnvironmentEnvironment tierGateway and zone managementInstalling or upgrading remote agentsJob managementMicroservicesObject tagsParameter managementPersonasPipelines and releasesPlugin managementPlugin configuration managementProcedure managementProcessProcess dependencyProcess stepProject managementProperty managementResource managementRolling deploySchedule managementService accounts for webhooksServer managementSingle sign on for SAMLSnapshotsTier mapTrigger managementUser and group managementUser profile email managementWait dependenciesWorkflow definition managementWorkflow managementWork itemsWorkspace managementMiscellaneous management
Perl API response and element glossary
IntroductionExamplesTroubleshooting
IntroductionaccesstokenaclaclentryactualparameteractualparametersapplicationapplicationdependencyapplicationtierarchiveconnectorartifactartifactversioncatalogcatalogitemcatalogitemruncibuildcibuilddetailciconfigurationcieventclustercomponentcredentialcredentialproviderdashboarddashboardcolumndataretentionpolicydeployerapplicationdeployerconfigurationdeploymenthistoryitemdevopsinsightdatasourcedirectoryprovideremailconfigemailnotifierentitychangeenvironmentenvironmentinventoryitemenvironmenttemplateenvironmenttemplatetierenvironmenttemplatetiermapenvironmenttemplatetiermappingenvironmenttierenvtempltierresourcetemplmappingeventsubscriptionflowruntimeformaloutputparameterformalparametergategatewaygrouphookjobjobstepkerberoskeytablicensemicroservicemicroservicemappingnoteobjectopenidconnectconfigurationoutputparameterpersonapersonacategorypersonapagepipelinepluginplugincatalogpluginconfigurationprocedureprocedurestepprocessprocessdependencyprocessstepprojectpropertyreleasereportreportingfilterreportobjectassociationreportobjectattributereportobjecttyperepositoryreservationresourceresourcepoolresourcetemplateresourceusageretrievedartifactsrollingdeployphaserundiscoverysamlidentityprovidersamlserviceproviderschedulescmsyncsearchfilterserverserversettingserversettingcategoryserviceaccountsessionsnapshotstagestatestatedefinitiontagtasktiermaptiermappingtransitiontransitiondefinitiontriggertriggererrordetailuseruseremailutilityresourcewaitdependencywebhookresultwidgetwidgetfilteroverrideworkflowworkflowdefinitionworkitemworkspacezoneArgument models

OpenIDConnectConfiguration

3 minute readReference

createOpenIDConnectConfiguration

Create a new OpenIDConnect Configuration

Arguments

Argument Name Type Description

clientId

String

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

openIDConnectConfigurationName

String

The name of the OpenID Connect provider. (Required)

serverUrl

String

URL for the service host (Required)

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

String

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.createOpenIDConnectConfiguration(
                clientId: 'test-clientId',
                openIDConnectConfigurationName: 'test-openIDConnectConfigurationName',
                serverUrl: 'test-serverUrl'
                /* optional arguments */)

deleteOpenIDConnectConfiguration

Deletes a OpenIDConnect configuration.

Arguments

Argument Name Type Description

openIDConnectConfigurationName

String

The name of the OpenID Connect provider. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.deleteOpenIDConnectConfiguration(
                openIDConnectConfigurationName: 'test-openIDConnectConfigurationName')

getOpenIDConnectConfiguration

Retrieve a OpenIDConnect configuration by name

Arguments

Argument Name Type Description

openIDConnectConfigurationName

String

The name of the OpenID Connect provider. (Required)

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getOpenIDConnectConfiguration(
                openIDConnectConfigurationName: 'test-openIDConnectConfigurationName')

getOpenIDConnectConfigurations

Retrieve all OpenIDConnect configurations

Arguments

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.getOpenIDConnectConfigurations()

modifyOpenIDConnectConfiguration

Modify an existing OpenIDConnect Configuration

Arguments

Argument Name Type Description

openIDConnectConfigurationName

String

The name of the OpenID Connect provider. (Required)

clientId

String

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

serverUrl

String

URL for the service host (Required)

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

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

String

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.

Usage

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


ElectricFlow ef = new ElectricFlow()

def result = ef.modifyOpenIDConnectConfiguration(
                openIDConnectConfigurationName: 'test-openIDConnectConfigurationName',
                clientId: 'test-clientId',
                serverUrl: 'test-serverUrl'
                /* optional arguments */)
object
outputparameter