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

successful operation

application/json; charset=UTF-8

Schema
Example (from schema)

Schema

anyOf

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

assumeRoleAccount string

Internal use only

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

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

enabled boolean

Enabled

eventbridgeRuleNamePrefix string

Amazon Event Bridge Rule Name

externalId string

External ID

features object[]

Features

Array [

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

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

roleArn string

Role ARN

storageScanConfig object

Model for AWS Storage Scan Configuration

buckets object

Selected List of S3 Buckets for forward and backward scan

property name* string[]

Array [

string

]

scanOption string

Possible values: [Realtime, Custom, Full, Historical]

Storage Scan Option

snsTopicArn string

SNS Topic ARN created on DLP SNS topic

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

assumeRoleAccount string

Internal use only

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

customMemberRoleNameEnabled boolean

defaultAccountGroupId string

Default Account Group

deploymentType string

Deployment Type

enabled boolean

Enabled

eventbridgeRuleNamePrefix string

Amazon Event Bridge Rule Name

externalId string

External ID

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

hierarchySelection object[]

List of selected resources for hierarchy selection

Array [

displayName string

To get the display name of resource, Refer List Children of Parent.

aws: List Children of Parent (AWS)

gcp: List Children of Parent (GCP). Display name is the organization name if nodeType is ORG

azure: List Children of Parent (Azure)

nodeType string

Possible values: [ORG, FOLDER, PROJECT, SUBSCRIPTION, MANAGEMENT_GROUP, TENANT, ACCOUNT, OU]

Member account node type. Supported values based on cloud type:

aws: ORG, OU, or ACCOUNT

gcp: ORG, FOLDER, or PROJECT

azure: SUBSCRIPTION, MANAGEMENT_GROUP, or TENANT

resourceId string

To get the list of resource IDs and its details, Refer List Children of Parent.

aws: List Children of Parent (AWS)

gcp: List Children of Parent (GCP)

azure: List Children of Parent (Azure)

selectionType string

Possible values: [ALL, INCLUDE, EXCLUDE]

Organization Member accounts Selection type.

ALL: Include the resource and all its children

INCLUDE: Include the specified resource

EXCLUDE: Exclude the specified resource

]

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

memberExternalId string

External Id in Member Accounts

memberRoleName string

Role Name in Member Accounts

memberRoleStatus boolean

Role Creation Status in Member Accounts

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

roleArn string

Role ARN

skipOverrideMemberRoleName boolean

storageScanConfig object

Model for AWS Storage Scan Configuration

buckets object

Selected List of S3 Buckets for forward and backward scan

property name* string[]

Array [

string

]

scanOption string

Possible values: [Realtime, Custom, Full, Historical]

Storage Scan Option

snsTopicArn string

SNS Topic ARN created on DLP SNS topic

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

unifiedCftDisabled boolean

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudAccountStatus object

Internal use only

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

ramArn string

Ram ARN

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudAccountStatus object

Internal use only

cloudType string

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

Cloud Type

defaultAccountGroupId string

Default Account Group Id

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

groupName string

Group Name

homeRegion string

Home Region

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

policyName string

Policy Name

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

userName string

User Name

userOcid string

User OCID

accountGroupInfos object[]

Account group details of groups associated with this account

Array [

autoCreated boolean

auto created

groupId string

group id

groupName string

Group name

lastModifiedBy string

Last modified by

]

accountId string

Account ID

accountType string

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

Cloud Account Type

addedOn int64

Added On

associatedAccountGroupsCount int32

Associated Account Groups Count with this cloud account

autoConsent string

cloudAccountOwner string

Cloud account owner

cloudAccountOwnerCount int32

Cloud account owner count

cloudType string

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

Cloud Type

deploymentType string

Deployment Type

enabled boolean

Enabled

features object[]

Features

Array [

defaultMemberState string

Possible values: [enabled, disabled]

name string

Feature name obtained from Fetch Supported Features endpoint

state string

Possible values: [enabled, disabled]

Feature state. Whether to be enabled or disabled

]

groupIds string[]

Group Ids

lastModifiedBy string

Last Modified By

lastModifiedTs int64

Time account was last updated

name string

Name

parentAccountId string

protectionMode string

Possible values: [MONITOR, MONITOR_AND_PROTECT]

Protection Mode

storageScanEnabled boolean

Storage Scan Enabled

storageUUID string

Storage UUID

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

Get Cloud Account Details

/cloud/:cloud_type/:id

Request​

Path Parameters

Query Parameters

Responses​

Request

Responses