README.md in esp_sdk-1.0.2 vs README.md in esp_sdk-1.0.3
- old
+ new
@@ -569,79 +569,96 @@
]
}
## External Accounts end point
### List action
- # list is a pageable response of 25 total external accounts per page
- api.external_accounts.list =>
- [
- [0] {
+
+ # list is a pageable response of 25 total external accounts per page
+ api.external_accounts.list =>
+ [
+ [0] {
+ "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"
+ }
+ ]
+ # Current page
+ api.external_accounts.current_page
+
+ # Next page sets current page with the next page results.
+ api.external_accounts.next_page
+
+ # Prev page sets current page with the previous page results.
+ api.external_accounts.prev_page
+
+### Show action
+ # Show a specific external account
+ # Required :id
+ 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"
}
- ]
- # Current page
- api.external_accounts.current_page
- # Next page sets current page with the next page results.
- api.external_accounts.next_page
+ # Current record
+ api.external_accounts.current_record
- # Prev page sets current page with the previous page results.
- api.external_accounts.prev_page
-
-### Show action
- # Show a specific external account
+### Update action
+ # Update a specific external account
# Required :id
- api.external_accounts.show(id: 1) =>
+ 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" => "Ops",
+ "nickname" => "Dev Ops",
"team_id" => 1,
"sub_organization_id" => 1,
"arn" => "arn:aws:iam::12345:role/evident_service_role",
"external_id" => "External ID"
}
- # Current record
- api.external_accounts.current_record
-
-### Update action
- # Update a specific external account
- # Required :id
- 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" => "Dev Ops",
- "team_id" => 1,
- "sub_organization_id" => 1,
- "arn" => "arn:aws:iam::12345:role/evident_service_role",
- "external_id" => "External ID"
- }
-
### Destroy action
- # Destroy a specific external account
- # Required :id
- api.external_accounts.destroy(id: 1) =>
- {
- "success" => "Dev Ops has been destroyed"
- }
+ # Destroy a specific external account
+ # Required :id
+ api.external_accounts.destroy(id: 1) =>
+ {
+ "success" => "Dev Ops has been destroyed"
+ }
### Create action
- # Create a new external account
-
+ # Create a new external account
+ Required: :arn, :external_id, :sub_organization_id, :team_id
+ 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"
+ }
## Services end point
#### *Note this end point is a read only end point, and requires the user to have manager role access
#### This end point can be used to for retrieving a service id to apply to a custom signature. Example your custom signature targets EC2 services.