PARTNERS

getCompanyDetailsByAWSAccountId

This method retrieves information regarding the managed companies that have configured the Amazon EC2 integration with a specific AWS account.

Parameters

Parameter

Type

Optional

Description

accountId

String

No

The ID of the AWS account

Return value

This method returns an Array containing the companies that have the AWS integration configured with the specified AWS account. The size of the returned list is limited to 25 entries. Each entry has the following structure:

  • type - company type: 0 for Partner, 1 for Customer

  • name - the name of the company

  • id - the ID of the company

  • address - the physical address of the company

  • phone - the phone of the company

  • canBeManagedByAbove - the security management status for the company: true, if the security can be managed by parent companies

  • isSuspended - company account status: true, if the company is suspended

  • createdAt - a String representing the UTC date and time at which the company was created

  • country - a String representing the country code in ISO 3166 format. If the code is not specified, the String has the value N/A

  • state - a String representing the country state code in ISO 3166 format. If the code is not specified, the String has the value N/A

  • contactPerson - an Object containing the details of the contact person:

    • fullName, their first name and surname

    • email, their business email address

    • phoneNumber, their business phone number

    • companyRole, their position in the company

Example

Request:

  {
       "params": {
           "accountId": "123456789012"
       },
       "jsonrpc": "2.0",
       "method": "getCompanyDetailsByAWSAccountId",
       "id": "ae037403-7947-4f2b-b0b2-af190a8b44eb"
  }  

Response:

  {
      "id":"ae037403-7947-4f2b-b0b2-af190a8b44eb",
      "jsonrpc":"2.0",
      "result": [{
          "type": 1,
          "name": "Test customer",
          "id": "55191c7ab1a43d1f107b23c7", 
          "address": "Str Example No 1",
          "phone": "0040740000001",
          "canBeManagedByAbove": true,
          "isSuspended": false,
          "createdAt": "2017-02-21T15:02:54",
          "country": "CA",
          "state": "CA-BC",
          "contactPerson": {
              "fullName": "Stephen Jhonson",
              "email": "stephen.jhonsons@example.email.com",
              "phoneNumber": "0040740000001",
              "companyRole": "Owner / President"
          }
      },
       {          "type": 0,
          "name": "Test partner",
          "id": "55191c5fb1a43da8107b23c6",
          "address": "Str Example No 2",
          "phone": "0040740000002",
          "canBeManagedByAbove": true,
          "isSuspended": false,
          "createdAt": "2017-01-28T15:01:15",
          "country": "CA",
          "state": "CA-BC",
          "contactPerson": {
              "fullName": "Stephen Jhonson",
              "email": "stephen.jhonsons@example.email.com",
              "phoneNumber": "0040740000001",
              "companyRole": "Owner / President"
          }
      }]
  }