Get Cloud Account Details

GET 
/cloud/:cloud_type/:id

Returns top level information about the cloud account.

Request

Path Parameters

cloud_type stringrequired

Possible values: [aws, azure, gcp, alibaba_cloud, oci]

Cloud Type

id stringrequired

Account ID

Query Parameters

includeGroupInfo boolean

true = Include account group info. Default is false.

Responses

200

successful operation

application/json; charset=UTF-8

Schema

Schema

accountType string

Possible values: [ACCOUNT, MASTER_SERVICE_ACCOUNT, COMPARTMENT, ORGANIZATION, TENANT]

Cloud Account Type

cloudType string

Possible values: [ALL, AWS, AZURE, GCP, ALIBABA_CLOUD, OCI, OTHER]

Cloud Type

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

groupIds string[]

Group Ids

storageScanEnabled boolean

Storage Scan Enabled

deploymentType string

Possible values: [AZURE, AZURE_GOVERNMENT, AZURE_CHINA, AWS, AWS_GOVERNMENT, AWS_CHINA, OCI, OCI_GOVERNMENT, OCI_CHINA, GCP, GCP_GOVERNMENT, GCP_CHINA, ALIBABA_CLOUD, ALIBABA_CLOUD_GOVERNMENT, ALIBABA_CLOUD_CHINA, ALIBABA_CLOUD_FINANCE]

Deployment Type

accountGroupInfos object[]
Account group details of groups associated with this account
Array [
groupName string
Group name
lastModifiedBy string
Last modified by
groupId string
group id
autoCreated boolean
auto created
]
autoConsent string
associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

storageUUID string

Storage UUID

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

parentAccountId string
features object[]
Features
Array [
name string
Feature name obtained from Fetch Supported Features endpoint
state string
Possible values: [enabled, disabled]
Feature state. Whether to be enabled or disabled
defaultMemberState string
Possible values: [enabled, disabled]
Enable or disable the feature for all the member accounts linked to this organization. You can enable or disable the defaultMemberState only if the feature state is enabled for the organization. Applicable only for Serverless Function Scanning and Agentless Workload Scanning features.
]
name string

Name

enabled boolean

Enabled

accountId string

Account ID

addedOn int64

Added On

Example (from schema)

{
  "accountType": "ACCOUNT",
  "cloudType": "ALL",
  "lastModifiedBy": "string",
  "lastModifiedTs": 0,
  "protectionMode": "MONITOR",
  "groupIds": [
    "string"
  ],
  "storageScanEnabled": true,
  "deploymentType": "AZURE",
  "accountGroupInfos": [
    {
      "groupName": "string",
      "lastModifiedBy": "string",
      "groupId": "string",
      "autoCreated": true
    }
  ],
  "autoConsent": "string",
  "associatedAccountGroupsCount": 0,
  "storageUUID": "string",
  "cloudAccountOwner": "string",
  "cloudAccountOwnerCount": 0,
  "parentAccountId": "string",
  "features": [
    {
      "name": "Remediation",
      "state": "enabled",
      "defaultMemberState": "enabled"
    }
  ],
  "name": "string",
  "enabled": true,
  "accountId": "string",
  "addedOn": 0
}

Loading...