List Children of Parent (AWS)

For AWS only. Lists all the children of the given parent organizational unit (OU).The listed children include both OU resources and account resources.

Path Parameters

• parent_id string required

  Parent OU ID

Query Parameters

• accountNextPageToken string

  The page token to request the next page of accounts. The response from a previous request provides this token. If the token has characters outside the ASCII character set, URL encode the token before using it to make a request.

• accountFetchCount int32

  Total number of accounts to return. An accountFetchCount of 0 returns a nextPageToken but no accounts.

• ouNextPageToken string

  The page token to request next set of OUs. The response from a previous request provides this token. If the token has characters outside the ASCII character set, URL encode the token before using it to make a request.

• ouFetchCount int32

  Total number of OUs to return. An ouFetchCount of 0 returns a nextPageToken but no OUs.

application/json

Request Body required

Cloud Account JSON

• accountId string required

  AWS Account ID

• accountType string required

  Possible values: [organization]

  Cloud Account Type

• enabled boolean

  Cloud Account Status. Whether or not the account is enabled

• name string

  Name

• roleArn string required

  AWS Role ARN

Responses

• 200
• 400
• 412
• 500

---

success

application/json; charset=UTF-8

• Schema
• Example (from schema)

---

Schema

• accountNextPageToken string

  Next page token for account

• ouNextPageToken string

  Next page token for Organizational Unit

• response object[]

  List of node info

  Array [

  displayName string

  Display name

  hasChild boolean

  Possible values: [true, false]

  Has Child

  id string

  Node ID

  parent string

  Parent

  type string

  Possible values: [ORG, FOLDER, PROJECT, SUBSCRIPTION, MANAGEMENT_GROUP, TENANT, ACCOUNT, OU]

  Node type

  ]

{
  "accountNextPageToken": "string",
  "ouNextPageToken": "string",
  "response": [
    {
      "displayName": "string",
      "hasChild": true,
      "id": "string",
      "parent": "string",
      "type": "ORG"
    }
  ]
}

permission_error / bad_request

external_id_empty_or_not_generated. To generate CFT and externalId call Generate and Download the AWS CFT Template endpoint or Generate the AWS CFT Template Link Endpoint

internal_error

Loading...