AccessToken

1 minute readReference

deleteAccessToken

Deletes an access token.

Arguments

Argument NameTypeDescription

serviceAccountName

String

The service account name. Use the getServiceAccounts command for a list of valid service account names. (Required)

accessTokenPublicId

String

The access token public id. (Required)

Response

No response.

ec-perl usage

$<object>->deleteAccessToken({<optionals>});

Example

$cmdr->deleteAccessToken ('qe service name', '1wv8qbi18y1nu7xs5jabutiy5zdkso');

ectool usage

Usage: deleteAccessToken <serviceAccountName> <accessTokenPublicId>

Example

ectool deleteAccessToken 'qe service name' '1wv8qbi18y1nu7xs5jabutiy5zdkso'

getAccessTokens

Returns access tokens for service account with associated trigger details.

Arguments

Argument NameTypeDescription

serviceAccountName

String

The service account name. Use the getServiceAccounts command for a list of valid service account names. (Required)

filters

Filter array

Filter criteria 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

String

Specifies order in which to sort results.

Response

<accessToken>
      <accessTokenId>b2cd9373-1d32-11ec-979d-42010a1eb03a</accessTokenId>
      <createTime>2021-09-24T12:26:52.634Z</createTime>
      <lastModifiedBy>admin</lastModifiedBy>
      <modifyTime>2021-09-24T12:26:52.634Z</modifyTime>
      <owner>admin</owner>
      <publicId>901tnqudquet9zd1dwbn2al2f5lafc</publicId>
      <serviceAccountName>qe service name</serviceAccountName>
      <trigger>
        <triggerId>b2c4b9c7-1d32-11ec-979d-42010a1eb03a</triggerId>
        <triggerName>qe trigger 1</triggerName>
        <accessTokenPublicId>901tnqudquet9zd1dwbn2al2f5lafc</accessTokenPublicId>
        <containerId>afb30d7e-1d32-11ec-963d-42010a1eb03a</containerId>
        <containerType>pipeline</containerType>
        <createTime>2021-09-24T12:26:52.634Z</createTime>
        <lastModifiedBy>admin</lastModifiedBy>
        <modifyTime>2021-09-24T12:26:52.634Z</modifyTime>
        <owner>admin</owner>
        <pipelineName>qe pipeline</pipelineName>
        <pluginKey>EC-Github</pluginKey>
        <projectName>qe proj</projectName>
        <propertySheetId>b2c4e0d9-1d32-11ec-979d-42010a1eb03a</propertySheetId>
        <quietTimeMinutes>0</quietTimeMinutes>
        <runDuplicates>1</runDuplicates>
        <serviceAccountName>qe service name</serviceAccountName>
        <tracked>1</tracked>
        <triggerEnabled>1</triggerEnabled>
        <triggerType>webhook</triggerType>
        <webhookName>default</webhookName>
        <pluginParameters>
          <parameterDetail>
            <parameterName>repositories</parameterName>
            <parameterValue>test/testrepo</parameterValue>
          </parameterDetail>
        </pluginParameters>
      </trigger>
    </accessToken>

ec-perl usage

$<object>->getAccessTokens({<optionals>});

Example

$cmdr->getAccessTokens('qe service name');

ectool usage

Usage: getAccessTokens <serviceAccountName>
        [--filters filter1 filter2 ...]
        [--firstResult <firstResult>]
        [--maxResults <maxResults>]
        [--sortKey <sortKey>]
        [--sortOrder <ascending|descending>]

Example

ectool getAccessTokens 'qe service name'