Update Cloud Account (OCI and Alibaba)
PUT/cloud/:cloud_type/:id
Update information related to a cloud account.
The request body parameters differ depending on the cloud type of the account you want to add.
Request Body to Update an Alibaba Account
The table below lists the request body parameters.
Parameter | Type | Description | Required? |
---|---|---|---|
accountId | string | AWS account ID | Required |
groupIds | array of strings | List of account group IDs for this account | Required |
name | string | Name to be used for the account on the Prisma Cloud platform (must be unique) | Required |
roleArn | string | Unique identifier for an Alibaba RAM role resource | Required |
enabled | boolean | Whether or not the account is enabled | Required |
deploymentType | string | Deployment type. Valid values: ali-int, ali-cn, ali-fn ali-int: Alibaba International ali-cn: Alibaba China. Allows you to monitor all the resources in the Alibaba China region, but does not monitor resources in the Alibaba Finance region. ali-fn: Alibaba Finance. Applicable only for the Alibaba China region. Allows you to monitor resources located only in the Alibaba Finance regions. | Optional |
Request Body Example
{
"accountId": "",
"groupIds": [],
"name": "",
"enabled": true,
"ramArn": ""
}
Request Body to Update an OCI Account
The table below lists the request body parameters to add an OCI account.
Parameter | Type | Description | Required? |
---|---|---|---|
accountType | string | OCI Account type. Current valid value is tenant. | Required |
defaultAccountGroupId | string | Account group ID for this account. Used for alert rules. | Required |
enabled | boolean | Whether or not to enable the account | Required |
name | string | Name of the OCI tenant you want Prisma Cloud to monitor | Required |
groupName | string | OCI identity group name that you define. Can be an existing group | Required |
homeRegion | string | OCI tenancy home region | Required |
policyName | string | OCI identity policy name that you define. Can be an existing policy that has the right policy statements. | Required |
accountId | string | OCID of your OCI tenancy | Required |
userName | string | OCI identity user name that you define. Can be an existing user that has the right privileges. | Required |
userOcid | string | User OCID from your OCI Tenant Console after you apply the zip file from Generate Zipped Terraform Script (OCI) in the console | Required |
Request Body Example
{
"accountType":"tenant",
"defaultAccountGroupId":"",
"enabled":true,
"name":"",
"groupName":"",
"homeRegion":"",
"policyName":"",
"accountId":"",
"userName":"",
"userOcid":""
}
Request
Path Parameters
id stringrequired
Account ID
cloud_type stringrequired
Possible values: [alibaba_cloud
, oci
]
Cloud Type
Query Parameters
skipStatusChecks boolean
true = Skip account status checks to improve response time
- application/json
Body
required
Cloud Account
property name* object
Responses
- 200
- 400
- 404
successful operation
invalid_account_id_format / duplicate_cloud_account_name / duplicate_cloud_account / cannot_select_zero_account_groups / invalid_account_group_ids
invalid_account_type
Loading...