Discover Accounts
Select
Create hypervisors corresponding to accounts that match organization's content rules.
Path Parameters
- organizationId int32 required
Id of an existing organization
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
discoveredAccounts object[]
accountEntityDetails object
Details of an AWS account
hypervisorDetails object
Details of hypervisor corresponding to the onboarded account
id int32name stringdisplayName stringhypervisorCreationAction stringPossible values: [
ORGANIZATION_ONBOARDING
,INDIVIDUAL_ADDITION
]The action that created the hypervisor
accountName stringName of the account
accountId stringId of the account
accountArn stringARN of the account
accountEmail stringE-mail corresponding to the account
organizationPath stringPath to the account in the organization structure
accountStatus stringPossible values: [
ACTIVE
,SUSPENDED
,PENDING_CLOSURE
]State of the account
warningMessage stringdiscoveryFailedAccounts object[]
accountDetails object
Details of an AWS account
accountName stringName of the account
accountId stringId of the account
accountArn stringARN of the account
accountEmail stringE-mail corresponding to the account
organizationPath stringPath to the account in the organization structure
accountStatus stringPossible values: [
ACTIVE
,SUSPENDED
,PENDING_CLOSURE
]State of the account
errorMessage string
{
"discoveredAccounts": [
{
"accountEntityDetails": {
"hypervisorDetails": {
"id": 0,
"name": "string",
"displayName": "string"
},
"hypervisorCreationAction": "ORGANIZATION_ONBOARDING",
"accountName": "string",
"accountId": "string",
"accountArn": "string",
"accountEmail": "string",
"organizationPath": "string",
"accountStatus": "ACTIVE"
},
"warningMessage": "string"
}
],
"discoveryFailedAccounts": [
{
"accountDetails": {
"accountName": "string",
"accountId": "string",
"accountArn": "string",
"accountEmail": "string",
"organizationPath": "string",
"accountStatus": "ACTIVE"
},
"errorMessage": "string"
}
]
}
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
discoveryFailedAccounts object[]
accountDetails object
Details of an AWS account
accountName stringName of the account
accountId stringId of the account
accountArn stringARN of the account
accountEmail stringE-mail corresponding to the account
organizationPath stringPath to the account in the organization structure
accountStatus stringPossible values: [
ACTIVE
,SUSPENDED
,PENDING_CLOSURE
]State of the account
errorMessage string
{
"errorType": "UNKNOWN",
"errorMessage": "string",
"discoveryFailedAccounts": [
{
"accountDetails": {
"accountName": "string",
"accountId": "string",
"accountArn": "string",
"accountEmail": "string",
"organizationPath": "string",
"accountStatus": "ACTIVE"
},
"errorMessage": "string"
}
]
}
Internal Server Error
- application/json
- Schema
- Example (from schema)
Schema
- errorMessage string
- errorCode int32
{
"errorMessage": "string",
"errorCode": 0
}