Accounts

This contains APIs related to accounts as defined in Harness

Gets an account

SecurityApiKey
Request
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

query 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": [
    ]
}

Update Account Name

SecurityApiKey
Request
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

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.

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.

productLed
boolean
nextGenEnabled
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",
  • "cluster": "string",
  • "defaultExperience": "NG",
  • "authenticationMechanism": "USER_PASSWORD",
  • "serviceAccountConfig": {
    },
  • "productLed": true,
  • "nextGenEnabled": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}

Update Default Experience

SecurityApiKey
Request
path Parameters
accountIdentifier
required
string

Account Identifier for the Entity.

Request Body schema: application/json

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.

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.

productLed
boolean
nextGenEnabled
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",
  • "cluster": "string",
  • "defaultExperience": "NG",
  • "authenticationMechanism": "USER_PASSWORD",
  • "serviceAccountConfig": {
    },
  • "productLed": true,
  • "nextGenEnabled": true
}
Response samples
{
  • "status": "SUCCESS",
  • "code": "DEFAULT_ERROR_CODE",
  • "message": "string",
  • "correlationId": "string",
  • "errors": [
    ]
}