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

Access token

1 minute readReference

deleteAccessToken

Deletes an access token.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

accessTokenPublicId

String

(Required) The access token public ID.

Positional arguments

serviceAccountName, accessTokenPublicId

Usage

ec-perl

$cmdr->deleteAccessToken(<serviceAccountName>, <accessTokenPublicId>);
▼

ectool

ectool deleteAccessToken serviceAccountName accessTokenPublicId
▼

getAccessTokens

Returns access tokens for a service account with associated trigger details.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

filters

Collection

A list of zero or more filter criteria definitions used to define objects to find.

firstResult

Integer

Result pagination: the first row to return.

maxResults

Integer

Result pagination: the number of rows to return.

sortKey

String

How to sort the results.

sortOrder

SortOrder

Specifies the order to sort the results.

Positional arguments

serviceAccountName

Usage

ec-perl

$cmdr->getAccessTokens(<serviceAccountName>, {<optionals>});
▼

ectool

ectool getAccessTokens serviceAccountName [optionals]
▼

getUserAccessToken

Retrieves user access token.

Arguments

Argument Name Type Description

userAccessTokenName

String

(Required) User access token name.

userName

String

User name.

Positional arguments

userAccessTokenName

Usage

ec-perl

$cmdr->getUserAccessToken(<userAccessTokenName>, {<optionals>});
▼

ectool

ectool getUserAccessToken userAccessTokenName [optionals]
▼

getUserAccessTokens

Retrieves user access token.

Arguments

Argument Name Type Description

userName

String

The name of a user for whom tokens should be returned.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool getUserAccessTokens [optionals]
▼

getUserAccessTokenSessions

Retrieves user access token sessions.

Arguments

Argument Name Type Description

userAccessTokenName

String

(Required) User access token name.

userName

String

User name.

Positional arguments

userAccessTokenName

Usage

ec-perl

$cmdr->getUserAccessTokenSessions(<userAccessTokenName>, {<optionals>});
▼

ectool

ectool getUserAccessTokenSessions userAccessTokenName [optionals]
▼

revokeToken

Revokes a user’s token. The API is deprecated. Use RevokeUserAccessToken instead.

This command is deprecated.

Arguments

Argument Name Type Description

token

String

The token.

userName

String

User name.

Positional arguments

None.

Usage

ec-perl

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

ectool

ectool revokeToken [optionals]
▼
Introduction
ACL