Skip to main content

Create an AWS Organization​

Select

SaaS
Customer Managed

Create an organization.
Only one organization can be created for each organization present in AWS.

Request Body
  • displayName string
  • 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

  • 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

Responses

OK

Schema
  • id int32
  • name string
POST /v4/cloud/aws/organization

Authorization

type: apiKeyname: Authtokenin: header

Request

Click Edit to configure Base URL
https://CommandCenterHostName/commandcenter/api
Security Scheme
token
Body
{

  "displayName": "string",

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

      }

    ]

  },

  "accountDiscoveryDetails": {

    "roleNameWithPath": "string",

    "backupServiceAccountId": "string",

    "accountAccessNodes": [

      {

        "id": 0,

        "name": "string",

        "displayName": "string",

        "accessNodeType": "SERVER"

      }

    ]

  }

}

curl -L -X POST 'https://CommandCenterHostName/commandcenter/api/V4/Cloud/AWS/Organization' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authtoken: <API_KEY_VALUE>' \
--data-raw '{
  "displayName": "string",
  "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"
      }
    ]
  },
  "accountDiscoveryDetails": {
    "roleNameWithPath": "string",
    "backupServiceAccountId": "string",
    "accountAccessNodes": [
      {
        "id": 0,
        "name": "string",
        "displayName": "string",
        "accessNodeType": "SERVER"
      }
    ]
  }
}'