Skip to main content

Describe Organization​

Select

SaaS
Customer Managed

Fetch details of an organization

Path Parameters
  • organizationId int32 required

    Id of an existing organization

Responses

OK

Schema
  • organization object

    Details of an AWS organization

  • id int32
  • name string
  • displayName string
  • organizationId string

    Id of the AWS organization

  • organizationArn string

    ARN of the AWS organization

  • masterAccountId string

    Id of the AWS organization's management account

  • masterAccountArn string

    ARN of the AWS organization's management account

  • masterAccountEmail string

    E-mail of the AWS organization's management account

  • credentialInfo object

    Details of credential used to access AWS resources

  • useIAMRoleAuthentication boolean

    Tells whether the locally attached IAM role is to be used for authentication

  • credentialId int32

    Id 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 int32
  • name string
  • displayName string
  • accessNodeType AccessNodeItemType

    Possible 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 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

  • accountDiscoveryDetails object

    Particulars required to create hypervisors corresponding to accounts in the organization

  • roleNameWithPath string

    Name of IAM role to assume to access accounts in the organization

  • backupServiceAccountId string

    Id 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 int32
  • name string
  • displayName string
  • accessNodeType AccessNodeItemType

    Possible values: [SERVER, SERVER_GROUP]

    Type of access node item

GET /v4/cloud/aws/organization/:organizationid

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
organizationId — path required
curl -L -X GET 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization/:organizationId' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>'