Skip to main content

Retrieve an AWS account

GET /accounts/aws/{cloudProviderAccountId}

Retrieves an AWS account using the public ID.

Caution This operation is deprecated.

Parameters

Name Type In Required Description

cloudProviderAccountId

string

path

True

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

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