# Deep Security Manager REST API

## Name: cloudAccount

A structure containing information about a cloud account.

JSON Example:
    {"cloudAccount":
     {
       "accessKey": String,
       "azureAdApplicationId": String,
       "azureAdApplicationName": String,
       "azureAdApplicationPassword": String,
       "azureAdTenantId": String,
       "azureAdTenantName": 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,
       "subscriptionName": String,
       "userId": String,
       "userPassword": String,
     }
    }

Elements
Name | Type | Required | Default Value | Description
--- | --- | --- | --- | ---
accessKey | String | No | `` | Used by AMAZON, the user access key.
azureAdApplicationId | String | No | `` | Application ID in the Azure Active Directory.
azureAdApplicationName | String | No | `` | Application name in the Azure Active Directory.
azureAdApplicationPassword | String | No | `` | Application password in the Azure Active Directory.
azureAdTenantId | String | No | `` | Tenant ID of the Azure Active Directory.
azureAdTenantName | String | No | `` | Tenant name of the Azure Active Directory.
azureCertificate | String | No | `` | 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 | String | No | `` | Password of Key Pair file for the Azure cloud. Leave blank if key pair is not encrypted.
cloudAccountId | Number | No | `` | Internal identifier uniquely identifying a cloud provider account.
cloudRegion | String | No | `` | 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 | String | No | `` | The cloud type; supported types are AMAZON, VCLOUD_PRIVATE_CLOUD, AZURE and AZURE_ARM. Note: Deep Security can now connect to Azure using the Resource Manager interface: Update the Azure cloud account with the cloud type AZURE_ARM, and the necessary parameters: subscriptionId, azureTenantId, azureApplicationId, azureApplicationPassword.
description | String | No | `` | Description to be associated to the cloud account.
endpoint | String | No | `` | IP Address of the vCloud cloud.
lastTimeSynchronized | Date | No | `` | Last time synchronized; provided by the server.
name | String | No | `` | User-friendly name to be given to the cloud account.
realTimeSynchronization | Boolean | No | `` | Control whether or not ongoing synchronization should be enabled.
secretKey | String | No | `` | Used by AMAZON, the user secret key.
subscriptionId | String | No | `` | Subscription ID of the Azure cloud.
subscriptionName | String | No | `` | Subscription name of the Azure cloud.
userId | String | No | `` | Used by VCLOUD_PRIVATE_CLOUD to uniquely identify an user; the format is usually <userid>@<organization>
userPassword | String | No | `` | Used by VCLOUD_PRIVATE_CLOUD as the user's password.

Copyright © 2017 Trend Micro Inc. All Rights Reserved.