Get GCP Cloud Account Status
Lists the status of a GCP Cloud account. You can use this API to verify the status of the security capabilities which you will be onboarding on Prisma Cloud.
- application/json
Request Body
- accountGroupCreationMode string
Possible values: [
MANUAL
,AUTO
,RECURSIVE
]Default value: MANUAL
MANUAL: Account will be mapped to the account group mentioned in
defaultAccountGroupId
.AUTO: Automatically creates account groups for each top-level folder in the hierarchy.
RECURSIVE: Automatically creates account groups for the folders that are nested within the GCP organization hierarchy.
Applicable only if the
accountType
is organization. cloudAccount object required
accountId string requiredOrganization resource ID if
accountType
is organization.Project ID if
accountType
is account or masterServiceAccount.accountType string requiredPossible values: [
account
,masterServiceAccount
,organization
]Cloud Account Type.
account: GCP Project
organization: GCP Organization
masterServiceAccount: Onboards all GCP projects that are accessible by the service account.
enabled booleanEnable or disable this account on Prisma Cloud.
Default value: false
groupIds string[]List of Account Groups that must be mapped to this account. To get the account group ids,call List Account Groups API
name string requiredAccount name for the GCP account that will be onboarded on Prisma Cloud. (must be unique)
projectId stringID of the project.
Get the project ID from the credentials json file that is generated from the GCP Terraform template.
- compressionEnabled boolean
Enable or disable compressed network flow log generation.
Default value: false
credentials object required
Add contents of the JSON file, which contains the credentials, that is generated from the GCP Terraform template.
auth_provider_x509_cert_url stringauth_uri stringclient_email stringclient_id stringclient_x509_cert_url stringprivate_key stringprivate_key_id stringproject_id stringtoken_uri stringtype string- dataflowEnabledProject string
Project ID where the Dataflow API is enabled .
Required if
compressionEnabled
is set to true and if theaccountType
is organization.Optional if the
accountType
is account or masterServiceAccount - defaultAccountGroupId string required
Applicable only
-
If
accountType
is organization andaccountGroupCreationMode
is MANUAL. -
If
accountType
is masterServiceAccount.
-
features object[]
Features to be enabled and/ or disabled. To get a list of all the supported features, see Fetch Supported Features endpoint
Array [name stringFeature name obtained from Fetch Supported Features endpoint
state stringPossible values: [
enabled
,disabled
]Feature state. Whether to be enabled or disabled
]- flowLogStorageBucket string
Cloud Storage Bucket name that is used store the flow logs.
hierarchySelection object[]
Applicable only if
accountType
is organization.Include/Exclude a list of GCP folders, GCP projects under the organization.
Array [displayName stringTo 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 ORGnodeType stringPossible 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 stringTo get the list of resource IDs and its details, Refer List Children of Parent.
aws: List Children of Parent (AWS)
selectionType stringPossible 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
]- organizationName string
GCP Organization name
- 200
- 400
- 500
successful operation
- application/json; charset=UTF-8
- Schema
- Example (from schema)
Schema
- Array [
- id string
- name string
- status string
statusMessage object
message stringstaticMessage boolean- ]
[
{
"id": "string",
"name": "string",
"status": "string",
"statusMessage": {
"message": "string",
"staticMessage": true
}
}
]
bad_request
internal_error