Skip to main content

Create Cloud Connection​

Creates a cloud connection.

Request Body
  • cloudType CloudConnectionCloudType

    Possible values: [AMAZON_WEB_SERVICES, MICROSOFT_AZURE, none, aws, azure, googleCloud]

    Cloud type for the connection.

  • connectionType CloudConnectionType

    Possible values: [CloudAccountLevel, OrganizationLevel]

    Type of the cloud connection.

  • name string

    Name of the cloud connection.

  • credentials object

    Credentials for cloud connections

  • credentialType CloudConnectionCredentialType

    Possible values: [AWS_STS_ASSUME_ROLE, AWS_IAM_ROLE]

    Type of credential to be used to access cloud connection.

  • credentialId int32

    ID of the saved credentials.

  • accessNodes object[]

    List of servers and server groups to use to access the cloud connection.

  • cloudSpecificConfiguration object

    Configuration settings specific to the connections cloud type.

  • aws object

    AWS specific cloud connection configuration.

  • regions string

    List of AWS regions to connect to.

  • iamRoleAccountId string

    ID of the AWS account which contains the IAM role to assume for authentication.

  • organizationConfiguration object

    Configuration for AWS Organization cloud connection.

  • content object

    Content for AWS Organization cloud connection.

  • accounts object[]

    List of AWS accounts

  • name string

    cloud account name

  • id string

    cloud account id

  • uuid string

    The globally unique identifier for the account

  • email string

    email for cloud account

  • discoverAllAccounts boolean

    Default value: false

    Discover all accounts in the AWS organization

  • enableOwnerDetection boolean

    Default value: false

    Enable owner detection for AWS accounts in the organization.

  • ownerDetectionConfiguration object

    Owner discovery configuration.

  • identityCenterRegion string required

    Region code of the region in which IAM Identity Center service is enabled in the AWS organization.

  • ownerPermissionSets string[] required

    List of IAM Identity center permission sets that identify account owners.

  • azure object

    Azure specific cloud connection configuration.

  • tenantId string

    Azure Tenant Id

  • tenantName string

    Azure Tenant Name

  • environment string

    Azure environment

  • subscriptions object[]

    List of Azure Subscriptions

  • name string

    cloud account name

  • id string

    cloud account id

  • uuid string

    The globally unique identifier for the account

  • email string

    email for cloud account

  • discoverAllSubscription boolean

    Default value: false

    Automatically discover future subscription in Azure tenant.

  • isCustomConfig boolean

    Default value: false

    Flag to indicate if custom configuration is used.

  • googleCloud object

    Google Cloud specific cloud connection configuration.

  • serviceAccount string

    Service Account email address

  • projects object[]

    List of Google Cloud projects.

  • name string

    cloud account name

  • id string

    cloud account id

  • uuid string

    The globally unique identifier for the account

  • email string

    email for cloud account

  • discoverAllProjects boolean

    Automatically discover future projects associated with the service account.

  • startDiscoveryJob boolean

    Default value: false

    Indicates whether the user wants to start the discovery job with the modification

  • enableDiscovery boolean

    Default value: true

    Indicates whether the user wants to discover resources with the new cloud connection

Responses

Success

Schema
  • id int32
  • name string
  • cloudDiscoveryJobId int32
  • error object
  • errorMessage string
  • errorCode int32
Loading...