Skip to main content

Get Cloud Connection Details​

Get details of one cloud connection

Path Parameters
  • cloudConnectionId int32 required

    Id of an existing cloud connection

Responses

Success

Schema
  • cloudConnection object

    Summary of a cloud connection entity

  • id int32
  • name string
  • displayName string
  • 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.

  • configType CloudConnectionConfigType

    Possible values: [EXPRESS_CONFIGURATION, CUSTOM_CONFIGURATION]

    Configuration type of the cloud connection.

  • company object
  • id int32

    Id of company

  • name string

    Name of company

  • multiCommcellId int32

    Multi Commcell Id of company

  • 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 connection.

  • id int32
  • name string
  • displayName string
  • accessNodeType AccessNodeItemType

    Possible values: [SERVER, SERVER_GROUP]

    Type of access node item

  • cloudSpecificDetails object

    Details specific to 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

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

  • ownerPermissionSets string[]

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

  • organizationDetails object

    Details of an AWS organization

  • 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

  • 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.

  • discoveryStatus DiscoveryOperationStatus

    Possible values: [NONE, NOT_STARTED, IN_PROGRESS, SUCCESS, FAILED]

    Status of discovery operation

  • lastDiscoveryDetails DiscoveryOperationDetails

    Details of discovery operation.

  • endTime int64

    Epoch time stamp of when the discovery operation ended.

  • errors string[]

    Errors (if any) that occured during the discovery operation.

  • discoveredAccounts object[]

    List of discovered cloud 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

  • credentialId int32

    Credential id associated with cloud account

  • status CloudAccountStatus

    Possible values: [NOT_VALIDATED, VALIDATED, VALIDATION_FAILED]

    Status of the cloud account.

  • errors string[]

    Errors associated with the cloud account

Loading...