Deep Security Manager REST API

Name: cloudAccount

A structure containing information about a cloud account.

XML Example:

<cloudAccount>
  <accessKey>xsd:string</accessKey>
  <azureCertificate>xsd:string</azureCertificate>
  <azureCertPassword>xsd:string</azureCertPassword>
  <cloudAccountId>xsd:int</cloudAccountId>
  <cloudRegion>xsd:string</cloudRegion>
  <cloudType>xsd:string</cloudType>
  <description>xsd:string</description>
  <endpoint>xsd:string</endpoint>
  <lastTimeSynchronized>xsd:datetime</lastTimeSynchronized>
  <name>xsd:string</name>
  <realTimeSynchronization>xsd:boolean</realTimeSynchronization>
  <secretKey>xsd:string</secretKey>
  <subscriptionId>xsd:string</subscriptionId>
  <userId>xsd:string</userId>
  <userPassword>xsd:string</userPassword>
</cloudAccount>

JSON Example:

{"cloudAccount":
 {
   "accessKey": String,
   "azureCertificate": String,
   "azureCertPassword": String,
   "cloudAccountId": Number,
   "cloudRegion": String,
   "cloudType": String,
   "description": String,
   "endpoint": String,
   "lastTimeSynchronized": Date,
   "name": String,
   "realTimeSynchronization": Boolean,
   "secretKey": String,
   "subscriptionId": String,
   "userId": String,
   "userPassword": String,
 }
}

Elements
Name	Type	Required	Nillable	Description
accessKey	xsd:string	false	false	Used by AMAZON, the user access key.
azureCertificate	xsd:string	false	false	Key Pair file for the Azure cloud. A PEM-encoded X509 file includes private/public key. The allowed format is base64 string of key pair file.
azureCertPassword	xsd:string	false	false	Password of Key Pair file for the Azure cloud. Leave blank if key pair is not encrypted.
cloudAccountId	xsd:int	false	false	Internal identifier uniquely identifying a cloud provider account.
cloudRegion	xsd:string	false	false	Represents a cloud partition/region, current mapping is the following: - amazon.cloud.region.key.1 maps to us-east-1 - amazon.cloud.region.key.2 maps to us-west-2 - amazon.cloud.region.key.3 maps to us-west-1 - amazon.cloud.region.key.4 maps to eu-west-1 - amazon.cloud.region.key.5 maps to ap-southeast-1 - amazon.cloud.region.key.6 maps to ap-northeast-1 - amazon.cloud.region.key.7 maps to sa-east-1
cloudType	xsd:string	false	false	The cloud type; supported types are AMAZON, VCLOUD_PRIVATE_CLOUD and AZURE.
description	xsd:string	false	false	Description to be associated to the cloud account.
endpoint	xsd:string	false	false	IP Address of the vCloud cloud.
lastTimeSynchronized	xsd:datetime	false	false	Last time synchronized; provided by the server.
name	xsd:string	false	false	User-friendly name to be given to the cloud account.
realTimeSynchronization	xsd:boolean	false	false	Control whether or not ongoing synchronization should be enabled.
secretKey	xsd:string	false	false	Used by AMAZON, the user secret key.
subscriptionId	xsd:string	false	false	Subscription ID of the Azure cloud.
userId	xsd:string	false	false	Used by VCLOUD_PRIVATE_CLOUD to uniquely identify an user; the format is usually <userid>@<organization>
userPassword	xsd:string	false	false	Used by VCLOUD_PRIVATE_CLOUD as the user's password.