External Accounts

Actions

• List
• Show
• Create
• Update
• Destroy

List

List a pageable response of 25 total external accounts per page

Example

api.external_accounts.list
> [
    {
      "id" => 1,
      "created_at" => "2014-10-22T16:23:19.615Z",
      "updated_at" => "2014-11-03T21:39:36.891Z",
      "organization_id" => 1,
      "nickname" => "Ops",
      "team_id" => 1,
      "sub_organization_id" => 1,
      "arn" => "arn:aws:iam::12345:role/evident_service_role",
      "external_id" => "External ID"
    }
 ]

Show

Show a specific external account

Parameters

Name	Type	Description
id	integer	Required. The ID of the external account

Example

api.external_accounts.show(id: 1)
> {
    "id" => 1,
    "created_at" => "2014-10-22T16:23:19.615Z",
    "updated_at" => "2014-11-03T21:39:36.891Z",
    "organization_id" => 1,
    "nickname" => "Ops",
    "team_id" => 1,
    "sub_organization_id" => 1,
    "arn" => "arn:aws:iam::12345:role/evident_service_role",
    "external_id" => "External ID"
  }

Create

Create a new external account.

Parameters

Name	Type	Description
arn	string	Required. ARN in Amazon.
external_id	string	Required. External ID in Amazon that goes with this ARN.
sub_organization_id	integer	Required. ID of the sub organization this account should belong to.
team_id	integer	Required. ID of the team this account should belong to.
nickname	string	A short name that is used for display purposes.

Example

api.external_accounts.create(arn: 'arn:aws:iam::12345:role/evident_service_role',
                             external_id: 'External ID',
                             nickname: 'Dev ops',
                             sub_organization_id: 1,
                             team_id: 1)
> {
    "id" => 3,
    "created_at" => "2014-11-24T15:37:35.249Z",
    "updated_at" => "2014-11-24T15:37:35.249Z",
    "organization_id" => 1,
    "nickname" => "Dev Ops",
    "team_id" => 1,
    "sub_organization_id" => 1,
    "arn" => "arn:aws:iam::12345:role/evident_service_role",
    "external_id" => "External ID"
  }

Update

Update a specific external account

Name	Type	Description
id	integer	Required. The ID of the external account.
arn	string	ARN in Amazon.
external_id	string	External ID in Amazon that goes with this ARN.
sub_organization_id	integer	ID of the sub organization this account should belong to.
team_id	integer	ID of the team this account should belong to.
nickname	string	A short name that is used for display purposes.

Example

> api.external_accounts.update(id: 1, nickname: 'Dev Ops')
  {
    "id" => 1,
    "created_at" => "2014-10-22T16:23:19.615Z",
    "updated_at" => "2014-11-03T21:39:36.891Z",
    "organization_id" => 1,
    "nickname" => "Test Account",
    "team_id" => 1,
    "sub_organization_id" => 1,
    "arn" => "arn:aws:iam::12345:role/evident_service_role",
    "external_id" => "External ID"
  }

Destroy

Destroy a specific external account

Name	Type	Description
id	integer	Required. The ID of the external account

Example

api.external_accounts.destroy(id: 1)
> {
    "success" => "Test Account has been destroyed"
  }