Harness

Accounts

This contains APIs related to accounts as defined in Harness

Gets an account

Securityx-api-key
Request
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Responses
400

Bad Request

500

Internal server error

default

Returns an account

get/ng/api/accounts/{accountIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Checks if immutable delegate is enabled for account
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns true if immutable delegate is enabled for account


get/ng/api/accounts/{accountIdentifier}/immutable-delegate-enabled
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
License update from UI
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
query Parameters
accountStatus
required
string
Account License Status for the Entity.


 
accountType
required
string
Account License Type for the Entity.


 
Responses 
400
Bad Request


500
Internal server error


default
Returns an boolean


put/ng/api/accounts/license/update/{accountIdentifier}
Request samples 
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update Account Name
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
This is details of the Account. Name is mandatory.


identifier
string
Account Identifier.


 
name
string
Name of the Account.


 
companyName
string
Name of the Company.


 
accountType
string
Type of the Account


 
accountStatus
string
Status of the Account


 
cluster
string
Name of the cluster associated with this Account.


 
defaultExperience
string
Default experience of the Account.


 Enum: "NG" "CG"  
authenticationMechanism
string
Authentication mechanism associated with the account.


 Enum: "USER_PASSWORD" "SAML" "LDAP" "OAUTH"  
object (ServiceAccountConfig) 
Service Account configuration associated with this Account.


 
createdAt
integer <int64> 
Account creation time in epoch


 
expiryTime
integer <int64> 
Account's license expiry time in epoch


 
ringName
string
Specifies delegate ring version for account


 
subdomainURL
string
Specifies subdomain url for account


 
sessionTimeoutInMinutes
integer <int32> 
SessionTimeout in minutes


 
publicAccessEnabled
boolean
Specifies if Account has public access enabled.


 
absoluteSessionTimeoutInMinutes
integer <int32> 
Absolute SessionTimeout in minutes


 
nextGenEnabled
boolean
 
crossGenerationAccessEnabled
boolean
 
twoFactorAdminEnforced
boolean
 
oauthEnabled
boolean
 
harnessSupportAccessAllowed
boolean
 
productLed
boolean
 
cannyUsernameAbbreviationEnabled
boolean
 
Responses 
400
Bad Request


500
Internal server error


default
Returns an account


put/ng/api/accounts/{accountIdentifier}/name
Request samples 
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "companyName": "string",
  • "accountType": "string",
  • "accountStatus": "string",
  • "cluster": "string",
  • "defaultExperience": "NG",
  • "authenticationMechanism": "USER_PASSWORD",
  • "serviceAccountConfig": {
    },
  • "createdAt": 0,
  • "expiryTime": 0,
  • "ringName": "string",
  • "subdomainURL": "string",
  • "sessionTimeoutInMinutes": 0,
  • "publicAccessEnabled": true,
  • "absoluteSessionTimeoutInMinutes": 0,
  • "nextGenEnabled": true,
  • "crossGenerationAccessEnabled": true,
  • "twoFactorAdminEnforced": true,
  • "oauthEnabled": true,
  • "harnessSupportAccessAllowed": true,
  • "productLed": true,
  • "cannyUsernameAbbreviationEnabled": true
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
Update Default Experience
Securityx-api-key 
Request 
path Parameters
accountIdentifier
required
string
Account Identifier for the Entity.


 
Request Body schema: application/json
required
This is details of the Account. DefaultExperience is mandatory


identifier
string
Account Identifier.


 
name
string
Name of the Account.


 
companyName
string
Name of the Company.


 
accountType
string
Type of the Account


 
accountStatus
string
Status of the Account


 
cluster
string
Name of the cluster associated with this Account.


 
defaultExperience
string
Default experience of the Account.


 Enum: "NG" "CG"  
authenticationMechanism
string
Authentication mechanism associated with the account.


 Enum: "USER_PASSWORD" "SAML" "LDAP" "OAUTH"  
object (ServiceAccountConfig) 
Service Account configuration associated with this Account.


 
createdAt
integer <int64> 
Account creation time in epoch


 
expiryTime
integer <int64> 
Account's license expiry time in epoch


 
ringName
string
Specifies delegate ring version for account


 
subdomainURL
string
Specifies subdomain url for account


 
sessionTimeoutInMinutes
integer <int32> 
SessionTimeout in minutes


 
publicAccessEnabled
boolean
Specifies if Account has public access enabled.


 
absoluteSessionTimeoutInMinutes
integer <int32> 
Absolute SessionTimeout in minutes


 
nextGenEnabled
boolean
 
crossGenerationAccessEnabled
boolean
 
twoFactorAdminEnforced
boolean
 
oauthEnabled
boolean
 
harnessSupportAccessAllowed
boolean
 
productLed
boolean
 
cannyUsernameAbbreviationEnabled
boolean
 
Responses 
400
Bad Request


500
Internal server error


default
Returns an account


put/ng/api/accounts/{accountIdentifier}/default-experience
Request samples 
application/json
{
  • "identifier": "string",
  • "name": "string",
  • "companyName": "string",
  • "accountType": "string",
  • "accountStatus": "string",
  • "cluster": "string",
  • "defaultExperience": "NG",
  • "authenticationMechanism": "USER_PASSWORD",
  • "serviceAccountConfig": {
    },
  • "createdAt": 0,
  • "expiryTime": 0,
  • "ringName": "string",
  • "subdomainURL": "string",
  • "sessionTimeoutInMinutes": 0,
  • "publicAccessEnabled": true,
  • "absoluteSessionTimeoutInMinutes": 0,
  • "nextGenEnabled": true,
  • "crossGenerationAccessEnabled": true,
  • "twoFactorAdminEnforced": true,
  • "oauthEnabled": true,
  • "harnessSupportAccessAllowed": true,
  • "productLed": true,
  • "cannyUsernameAbbreviationEnabled": true
}
Response samples 
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}
➔ Next to AccountSetting