Skip to main content

Create an AWS account

POST /accounts/aws

Creates an AWS account.

Caution This operation is deprecated.

Request Body

Name Type Required Description

accountName

string

False

providerKeys

AwsKeysRequest

True

subscriptionId

string

False

Example request
{
  "accountName": "string",
  "providerKeys": {
    "awsAccessKeys": {
      "accessKey": "string",
      "secretKey": "string"
    },
    "assumeRoleArn": "string"
  },
  "subscriptionId": "string"
}

Error

Status: Default, Default response
Name Type Required Description

publicId

string

True

accountName

string

False

accountType

string

False

accountId

string

False

accessKey

string

False

assumeRole

AssumeRole

False

occmRole

string

False

vsaList

array[AccountWorkingEnvironmentResponse]

True

subscriptionId

string

False

Example error response
{
  "publicId": "string",
  "accountName": "string",
  "accountType": "string",
  "accountId": "string",
  "accessKey": "string",
  "assumeRole": {
    "roleName": "string",
    "accountId": "string"
  },
  "occmRole": "string",
  "vsaList": [
    {
      "publicId": "string",
      "name": "string",
      "workingEnvironmentType": "string"
    }
  ],
  "subscriptionId": "string"
}

Definitions

See Definitions

AwsAccessKeys

Name Type Required Description

accessKey

string

True

secretKey

string

False

AwsKeysRequest

Name Type Required Description

awsAccessKeys

AwsAccessKeys

False

assumeRoleArn

string

False

AssumeRole

Name Type Required Description

roleName

string

False

accountId

string

False

isGov

boolean

False

AccountWorkingEnvironmentResponse

Name Type Required Description

publicId

string

False

name

string

False

workingEnvironmentType

string

False