-
Service Account Management: A service account is a special account object for use with webhooks management.
-
Session Management: A session object is used for webhooks management and runs in the context of a service account.
createServiceAccount
Creates a new ServiceAccount object. Use a service account when creating and managing webhooks sessions.
You must specify a serviceAccountName
.
Arguments | Descriptions |
---|---|
serviceAccountName |
The service account name. Argument type: String |
description |
(Optional) Comment text describing this object that is not interpreted at all by CloudBees CD/RO . Argument type: String |
Response
Returns a serviceAccount object.
deleteServiceAccount
Deletes a service account.
You must specify the serviceAccountName
object to delete.
Arguments | Descriptions |
---|---|
serviceAccountName |
The service account name to delete. Argument type: String |
getServiceAccount
Retrieves a service account by its name.
You must specify the serviceAccountName
object to retrieve.
Arguments | Descriptions |
---|---|
serviceAccountName |
The name of the service account to retrieve. Argument type: String |
Response
Returns a serviceAccount object.
getServiceAccounts
Retrieves all service accounts.
Arguments | Descriptions |
---|---|
None |
– |
Response
Returns zero or more serviceAccount objects.
modifyServiceAccount
You must specify a serviceAccountName
.
Arguments | Descriptions |
---|---|
serviceAccountName |
The service account name to modify. Argument type: String |
description |
(Optional) Comment text describing this object that is not interpreted at all by CloudBees CD/RO . Argument type: String |
newName |
(Optional) New name for an existing service account that is being renamed. Argument type: String |
Response
Returns a serviceAccount object.
createSession
Creates a new webhooks session. You must specify a serviceAccountName
to use as the managing account for the webhooks session.
Arguments | Descriptions |
---|---|
serviceAccountName |
The service account name as returned by createServiceAccount . Use getServiceAccounts to get a list of current account names. Argument type: String |
expirationDate |
(Optional) Argument type: Date |
timeZone |
(Optional) The time zone specified to use for this session (Java-compatible string). Argument type: TimeZone specification |
Response
Returns a session object.
deleteSession
Deletes a webhooks session. You must specify the sessionID
for the session to delete.
Arguments | Descriptions |
---|---|
sessionId |
The sessionID of the session to delete, as returned by the getSessions command. Argument type: UUID |
getSessions
Retrieves webhooks sessions managed by the specified service account name. You must specify the serviceAccountName
of the webhooks sessions to retrieve.
Arguments | Descriptions |
---|---|
serviceAccountName |
The managing account for the webhooks sessions to retrieve. This account must have read privilege on the session object. Argument type: String |
Response
Returns zero or more session objects.
modifySession
You must specify a sessionId
.
Arguments | Descriptions |
---|---|
sessionId |
The session ID of the session to modify as returned by the getSessions command. Argument type: UUID |
expirationDate |
(Optional) Argument type: Date |
timeZone |
(Optional) The time zone specified to use for this session (Java-compatible string). Argument type: TimeZone specification |
Response
Returns the modified session object.