[DEPRECATED] This API is deprecated. Creates a session.
Arguments
Argument Name
Type
Description
expirationDate
String
The date when this session will expire.
serviceAccountName
String
Service account name under for which the webhook session needs to be
created for.
timeZone
String
The time zone to use when interpreting expiration date.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.createSession(
/* optional arguments */)
▼
deleteSession
[DEPRECATED] This API is deprecated. Deletes a session.
Arguments
Argument Name
Type
Description
sessionId
String
ID of the session.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.deleteSession()
▼
getSessions
[DEPRECATED] This API is deprecated. Retrieves all sessions for a
service account.
Arguments
Argument Name
Type
Description
serviceAccountName
String
Service account name under for which the webhook session needs to be
created for.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.getSessions()
▼
login
Login the client with the given credentials.
Arguments
Argument Name
Type
Description
password
String
Secret value used to identify the account for a particular user.
userName
String
User name under which you wish to login.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.login(
/* optional arguments */)
▼
loginSso
Sign in to the client with single-sign on (SSO).
Arguments
Argument Name
Type
Description
code
String
OAuth 2.0 Authorization Code.
samlResponse
String
SAML response.
state
String
OAuth 2.0 state value.
token
String
Token generation.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.loginSso(
/* optional arguments */)
▼
logout
Signs out of the client session.
Arguments
Argument Name
Type
Description
jwtToken
String
JWT token.
uiLogout
Boolean
If true, server will return URL for redirect to logout from CI.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.logout(
/* optional arguments */)
▼
modifySession
[DEPRECATED] This API is deprecated. Modifies a session.
Arguments
Argument Name
Type
Description
sessionId
String
ID of the session.
expirationDate
String
The date when this session will expire.
timeZone
String
The time zone to use when interpreting expiration date.
Usage
import com.electriccloud.client.groovy.ElectricFlow
import com.electriccloud.client.groovy.models.*
ElectricFlow ef = new ElectricFlow()
def result = ef.modifySession(
/* optional arguments */)