Preview Organization content

Select

SaaS

Customer Managed

Discovers the accounts in the AWS organization that matches the defined content rules.

application/json

Request Body

• credential object required

  Credential to be used to be access AWS Organization

  credentialType AWSOrganizationCredentialType required

  Possible values: [CREDENTIALS_MANAGER_CREDENTIAL, AWS_STS_ASSUME_ROLE, AWS_IAM_ROLE]

  Type of credential to be used to access AWS Organization

  credentialId int32

  ID of the saved credential. Applicable only if credentialType is CREDENTIALS_MANAGER_CREDENTIAL.

  awsIamRoleArn string

  ARN of the IAM Role to assume. Applicable only if credentialType is AWS_ASSUME_ROLE.

  awsExternalId string

  External ID to use when assuming IAM Role. Applicable only if credentialType is AWS_ASSUME_ROLE.

• accessNodes object[] required

  List of servers and server groups to use to access the organization.

• tagContents object

  Details of tags that define the contents of the organization. If the field is left empty, all visible accounts will be treated as organization's content.

  tagType AWSOrganizationTagContentType

  Possible values: [ORGANIZATIONAL_UNIT_TAG, ACCOUNT_TAG]

  Type of the content tags

  tags object[]

  key string

  Tag key content to match

  value string

  Tag value content to match

Responses

• 200
• 400
• 500

---

OK

application/json

• Schema
• Example (from schema)

---

Schema

• discoveredAccounts object[]

  accountName string

  Name of the account

  accountId string

  Id of the account

  accountArn string

  ARN of the account

  accountEmail string

  E-mail corresponding to the account

  organizationPath string

  Path to the account in the organization structure

  accountStatus string

  Possible values: [ACTIVE, SUSPENDED, PENDING_CLOSURE]

  State of the account

{
  "discoveredAccounts": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountArn": "string",
      "accountEmail": "string",
      "organizationPath": "string",
      "accountStatus": "ACTIVE"
    }
  ]
}

Bad Request

application/json

• Schema
• Example (from schema)

---

Schema

• errorType AWSOrganizationErrorType

  Possible values: [UNKNOWN, INVALID_REQUEST, ACCESS_NODE_COMMUNICATION_FAILED, SERVICE_ENDPOINT_NOT_REACHABLE, CREDENTIAL_INVALID, NOT_ENOUGH_PERMISSIONS, ALL_ACCOUNTS_FAILED_DISCOVERY]

  Type of AWS Organization specific error that occured

• errorMessage string

{
  "errorType": "UNKNOWN",
  "errorMessage": "string"
}

Internal Server Error

application/json

• Schema
• Example (from schema)

---

Schema

• errorMessage string
• errorCode int32

{
  "errorMessage": "string",
  "errorCode": 0
}

POST /v4/cloud/aws/organization/content/preview    

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL

https://CommandCenterHostName/commandcenter/api

Security Scheme

tokenbearerToken

token

Body

{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/Content/Preview' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "credential": {
    "credentialType": "CREDENTIALS_MANAGER_CREDENTIAL",
    "credentialId": 0,
    "awsIamRoleArn": "string",
    "awsExternalId": "string"
  },
  "accessNodes": [
    {
      "id": 0,
      "name": "string",
      "displayName": "string",
      "accessNodeType": "SERVER"
    }
  ],
  "tagContents": {
    "tagType": "ORGANIZATIONAL_UNIT_TAG",
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
    ]
  }
}'