Update Organizational Id

put https://api.dome9.com/v2/cloudaccounts/{id}/organizationalUnit

Update the ID of the Organizational Unit that this cloud account will be attached to.
Use 'null' for the root Organizational Unit

time	status	user agent
Retrieving recent requests…

Loading…

Response

Response body

object

uuid

[Readonly] The Dome9 id

vendor

string

[Readonly] The cloud provider (AWS)

aws hp mellanox awsgov azure google awschina azuregov kubernetes azurechina terraform generic kubernetesruntimeassurance shiftleft sourcecodeassurance imageassurance alibaba cft containerregistry oci ocigov ocigovuk CIEM

name

string

The cloud account name

externalAccountNumber

string

[Readonly] The AWS account number

error

string

[Readonly] credentials error status

isFetchingSuspended

boolean

[Readonly] fetching suspending status

creationDate

date-time

[Readonly] account creation date

credentials

object

[Required] The information needed for Dome9 System in order to connect to the AWS cloud account

apikey

string

[Deprecated]

arn

string

[Required] AWS Role ARN (to be assumed by Dome9 System)

secret

string

[Required] The AWS role External ID (Dome9 System will have to use this secret in order to assume the role)

iamUser

string

[Deprecated]

type

string

[Required] The cloud account onbiarding method. Should be set to "RoleBased" as other methods are deprecated

UserBased RoleBased

isReadOnly

boolean

[Readonly] The credential permission state.
This filed is determined based on the operation response status performed by Dome9 on the target AWS cloud account.

iamSafe

object

[Readonly] The IamSafety configuration of the AWS cloud account

awsGroupArn

string

awsPolicyArn

string

mode

string

OptIn Mandatory

state

string

Enabled Disabled

excludedIamEntities

object

restrictedIamEntities

object

netSec

object

[Readonly] The network security configuration for the AWS cloud account.

regions

array of objects

List of network security configuration per AWS region

regions

object

region

string

[Required] Dome9 representation value for the AWS region

us_east_1 us_west_1 eu_west_1 ap_southeast_1 ap_northeast_1 us_west_2 sa_east_1 az_1_region_a_geo_1 az_2_region_a_geo_1 az_3_region_a_geo_1 ap_southeast_2 mellanox_region us_gov_west_1 eu_central_1 ap_northeast_2 ap_south_1 us_east_2 ca_central_1 eu_west_2 eu_west_3 eu_north_1 cn_north_1 cn_northwest_1 us_gov_east_1 ap_east_1 me_south_1 af_south_1 eu_south_1 ap_northeast_3 me_central_1 ap_south_2 ap_southeast_3 ap_southeast_4 eu_central_2 eu_south_2 il_central_1 ca_west_1 mx_central_1 ap_southeast_5 ap_southeast_7 westus eastus eastus2 northcentralus westus2 southcentralus centralus usgovlowa usgovvirginia northeurope westeurope eastasia southeastasia japaneast japanwest brazilsouth australiaeast australiasoutheast centralindia southindia westindia canadaeast westcentralus chinaeast chinanorth canadacentral germanycentral germanynortheast koreacentral uksouth ukwest koreasouth francecentral francesouth germanywestcentral usdodcentral usdodeast usgovarizona usgovtexas australiacentral australiacentral2 chinaeast2 chinanorth2 southafricanorth southafricawest uaecentral uaenorth ussecwest usseceast germanynorth switzerlandwest norwaywest norwayeast switzerlandnorth westus3 swedencentral chinanorth3 brazilsoutheast eastus2euap jioindiawest jioindiacentral qatarcentral spaincentral italynorth polandcentral mexicocentral asia asia_east1 asia_northeast1 asia_south1 asia_southeast1 australia_southeast1 europe europe_north1 europe_west1 europe_west2 europe_west3 europe_west4 northamerica_northeast1 southamerica_east1 us us_central1 us_east1 us_east4 us_west1 us_west2 global asia_east2 eur4 nam4 europe_west6 japan_west asia_northeast2 asia_northeast3 us_west3 us_west4 asia_southeast2 nam3 nam5 nam6 nam7 nam10 nam_eur_asia1 eur3 eur5 asia1 nam11 eu northamerica_northeast2 southamerica_west1 us_east5 us_south1 europe_central2 europe_southwest1 europe_west8 europe_west9 europe_west10 europe_west12 asia_south2 australia_southeast2 me_central1 me_central2 me_west1 ap_sydney_1 ap_melbourne_1 sa_saopaulo_1 sa_vinhedo_1 ca_montreal_1 ca_toronto_1 sa_santiago_1 eu_paris_1 eu_marseille_1 eu_frankfurt_1 ap_hyderabad_1 ap_mumbai_1 il_jerusalem_1 eu_milan_1 ap_osaka_1 ap_tokyo_1 mx_queretaro_1 eu_amsterdam_1 me_jeddah_1 ap_singapore_1 af_johannesburg_1 ap_seoul_1 ap_chuncheon_1 eu_madrid_1 eu_stockholm_1 eu_zurich_1 me_abudhabi_1 me_dubai_1 uk_london_1 uk_cardiff_1 us_ashburn_1 us_phoenix_1 us_sanjose_1 us_gov_ashburn_1 us_gov_chicago_1 us_gov_phoenix_1 us_langley_1 us_luke_1 uk_gov_london_1 uk_gov_cardiff_1 sa_bogota_1 us_chicago_1 sa_valparaiso_1 mx_monterrey_1 eu_jovanovac_1 ap_singapore_2

name

string

[Readonly] The region name

hidden

boolean

[Deprecated]

newGroupBehavior

string

[Required] The Protection Mode that Dome9 will apply to new security groups detected in the cloud account.
ReadOnly New Security Groups will be included in Dome9 in Read-Only mode, without changes to any of the rules
FullManage New Security Groups will be included in Dome9 in Full Protection mode, without changes to any of the rules
Reset New Security Groups will be included in Dome9 in Full Protection mode, and all inbound and outbound rules will be cleared

ReadOnly FullManage Reset

magellan

boolean

[Readonly] Flag to determine if Magellan is enabled/disabled for the account

fullProtection

boolean

[Required] As part of the AWS account onboarding, the account security groups are imported.
This flag determines whether to enable Tamper Protection mode for those security groups.

allowReadOnly

boolean

[Required] Determines the AWS cloud account operation mode.
For "Manage" set to true, for "Readonly" set to false.

organizationId

string

The unique identifier (ID) of an AWS organization. E.g. 9w9xc7rq7p

organizationalUnitId

uuid

organizationalUnitPath

string

organizationalUnitName

string

lambdaScanner

boolean

Flag indicating if lambda scanner is enabled/disabled for the account

serverless

object

codeAnalyzerEnabled

boolean

codeDependencyAnalyzerEnabled

boolean

onboardingMode

string

Undefined Legacy CloudGuardManaged CustomerManaged

Language

Credentials

Basic

base64

URL


xxxxxxxxxx
1
curl --request PUT \
2
     --url https://api.dome9.com/v2/cloudaccounts/id/organizationalUnit \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200OK