Service accounts for webhooks

1 minute readReference

createServiceAccount

Creates a new service account object and uses a service account when creating and managing webhooks sessions.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

description

String

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

Positional arguments

serviceAccountName

Usage

ec-perl

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

ectool

ectool createServiceAccount serviceAccountName, [optionals]

deleteServiceAccount

Deletes a service account.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

Positional arguments

serviceAccountName

Usage

ec-perl

$cmdr->deleteServiceAccount(<serviceAccountName>);

ectool

ectool deleteServiceAccount serviceAccountName

getServiceAccount

Retrieves a service account by its name.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

Positional arguments

serviceAccountName

Usage

ec-perl

$cmdr->getServiceAccount(<serviceAccountName>);

ectool

ectool getServiceAccount serviceAccountName

getServiceAccounts

Retrieves all service accounts.

Arguments

None.

Positional arguments

None.

Usage

ec-perl

$cmdr->getServiceAccounts();

ectool

ectool getServiceAccounts

modifyServiceAccount

Modifies a service account.

Arguments

Argument Name Type Description

serviceAccountName

String

(Required) The service account name.

description

String

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

newName

String

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

Positional arguments

serviceAccountName

Usage

ec-perl

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

ectool

ectool modifyServiceAccount serviceAccountName, [optionals]