Skip to main content

getAmazonEC2ExternalIdForCrossAccountRole

This method returns the External ID required to configure the AWS Cross-Account Role.

Parameters

Parameter

Type

Optional

Description

companyId

String

Yes

The ID of the target company. The default value is the ID of the company linked to the user who generated the API key.

Return value

This method returns a String: the External ID. If no External ID was generated, this method will return null.

Example

Request:

  {
       "params": {
           "companyId": "55115935b1a43dcc4a7b23c6"
       },
       "jsonrpc": "2.0",
       "method": "getAmazonEC2ExternalIdForCrossAccountRole",
       "id": "5c6df60c-786a-4ea3-8ff3-b6e52b42aa46"
  }  

Response:

  {
      "id": "5c6df60c-786a-4ea3-8ff3-b6e52b42aa46",
      "jsonrpc":"2.0",
      "result": "5e93f474a30a2db85dd6046d6d5fg188"
  }