Describe Organization
Select
Fetch details of an organization
Path Parameters
- organizationId int32 required
Id of an existing organization
- 200
- 400
- 500
OK
- application/json
- Schema
- Example (from schema)
Schema
organization object
Details of an AWS organization
id int32name stringdisplayName stringorganizationId stringId of the AWS organization
organizationArn stringARN of the AWS organization
masterAccountId stringId of the AWS organization's management account
masterAccountArn stringARN of the AWS organization's management account
masterAccountEmail stringE-mail of the AWS organization's management account
credentialInfo object
Details of credential used to access AWS resources
useIAMRoleAuthentication booleanTells whether the locally attached IAM role is to be used for authentication
credentialId int32Id of the saved credential for authentication methods other than IAM Role
accessNodes object[]
List of servers and server groups to use to access the organization.
id int32name stringdisplayName stringaccessNodeType AccessNodeItemTypePossible values: [
SERVER
,SERVER_GROUP
]Type of access node item
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 AWSOrganizationTagContentTypePossible values: [
ORGANIZATIONAL_UNIT_TAG
,ACCOUNT_TAG
]Type of the content tags
tags object[]
key stringTag key content to match
value stringTag value content to match
accountDiscoveryDetails object
Particulars required to create hypervisors corresponding to accounts in the organization
roleNameWithPath stringName of IAM role to assume to access accounts in the organization
backupServiceAccountId stringId of the account that hosts the Commvault backup infrastructure
accountAccessNodes object[]
List of servers and server groups to use to access the onboarded accounts
id int32name stringdisplayName stringaccessNodeType AccessNodeItemTypePossible values: [
SERVER
,SERVER_GROUP
]Type of access node item
{
"organization": {
"id": 0,
"name": "string",
"displayName": "string",
"organizationId": "string",
"organizationArn": "string",
"masterAccountId": "string",
"masterAccountArn": "string",
"masterAccountEmail": "string",
"credentialInfo": {
"useIAMRoleAuthentication": true,
"credentialId": 0
},
"accessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"accessNodeType": "SERVER"
}
],
"tagContents": {
"tagType": "ORGANIZATIONAL_UNIT_TAG",
"tags": [
{
"key": "string",
"value": "string"
}
]
},
"accountDiscoveryDetails": {
"roleNameWithPath": "string",
"backupServiceAccountId": "string",
"accountAccessNodes": [
{
"id": 0,
"name": "string",
"displayName": "string",
"accessNodeType": "SERVER"
}
]
}
}
}
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
}