From 6c85e146d0034307678876d1f958455c3cf8ca74 Mon Sep 17 00:00:00 2001 From: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> Date: Thu, 14 Nov 2024 11:39:39 +0530 Subject: [PATCH 1/4] RLP_151624 changes --- .../api/cspm/api-integration-config.md | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/products/prisma-cloud/api/cspm/api-integration-config.md b/products/prisma-cloud/api/cspm/api-integration-config.md index 319ca2e84..0f88d3191 100644 --- a/products/prisma-cloud/api/cspm/api-integration-config.md +++ b/products/prisma-cloud/api/cspm/api-integration-config.md @@ -10,6 +10,77 @@ The request body for some of the endpoints includes an `integrationConfig` param Note that most external systems require some configuration before you can use the Prisma Cloud API endpoints to add an integration to that system. For more details, see [Prisma Cloud Integrations](https://docs.prismacloud.io/en/classic/cspm-admin-guide/configure-external-integrations-on-prisma-cloud/prisma-cloud-integrations). If you are upgraded to the Darwin release, see [Prisma Cloud Integrations](https://docs.prismacloud.io/en/enterprise-edition/content-collections/administration/configure-external-integrations-on-prisma-cloud/prisma-cloud-integrations). +### AWS Security Hub + +Prisma Cloud integrates with AWS Security Hub for centralized visibility into security and compliance risks associated with your cloud assets on the AWS Security Hub console. + +As a part of the integration, Prisma Cloud monitors your AWS cloud assets. It sends alerts about resource misconfigurations, compliance violations, network security risks, and anomalous user activities directly to the AWS Security Hub console providing a centralized and comprehensive view of the cloud assets deployed on your AWS accounts. + + +Note: Prisma Cloud integration with AWS Security Hub is not supported for `US Gov Cloud` regions. + + +#### Add, Update, or Test an AWS Security Hub Integration + + +To add an AWS Security Hub integration, make your request as described in +[Add Integration](/prisma-cloud/api/cspm/create-integration-v-1). As part of the request body, the `integrationType` parameter is `aws_security_hub`, and the `integrationConfig` parameter contains the following key/value pairs. + + +| Key | Value Description | Value Type | Default Value or Required | +| -------------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------- | +| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | Array of Objects
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required | +| defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | +| accountId | The Account ID of the AWS account that you have onboarded on Prisma Cloud | string | Required | + + +To update an AWS Security Hub integration, make your request as described in +[Update Integration](/prisma-cloud/api/cspm/update-integration-v-1). Parameter `integrationConfig` is mutable. + + +To test an AWS Security Hub, make your request as described in +[Test Integration](/prisma-cloud/api/cspm/test-integration). + + +##### Example Request Body to Add an Amazon Security Hub Integration + + +```json +{ + "description": "", + "enabled": true, + "integrationConfig": { + "regions": [ + { + "name": "", + "apiIdentifier": "", + "cloudType": "", + "sdkId": "", + "enabled": true + }, + { + "name": "", + "apiIdentifier": "", + "cloudType": "", + "sdkId": "", + "enabled": true + } + ], + "defaultRegion": { + "name": "", + "apiIdentifier": "", + "cloudType": "", + "sdkId": "", + "enabled": true + }, + "accountId": "" + }, + "integrationType": "", + "name": "", + "id": "" +} +``` + ### Amazon Security Lake Prisma Cloud integrates with Amazon Security Lake to ingest Prisma Cloud Open Cybersecurity Schema Framework (OCSF) compliant vulnerability security data into Amazon Security Lake. From d515c5b92812a13603f291c07b6f05082f9b0ca4 Mon Sep 17 00:00:00 2001 From: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> Date: Thu, 14 Nov 2024 12:18:39 +0530 Subject: [PATCH 2/4] RLP-151624 changes --- products/prisma-cloud/api/cspm/api-integration-config.md | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/products/prisma-cloud/api/cspm/api-integration-config.md b/products/prisma-cloud/api/cspm/api-integration-config.md index 0f88d3191..4059d9cf9 100644 --- a/products/prisma-cloud/api/cspm/api-integration-config.md +++ b/products/prisma-cloud/api/cspm/api-integration-config.md @@ -10,6 +10,7 @@ The request body for some of the endpoints includes an `integrationConfig` param Note that most external systems require some configuration before you can use the Prisma Cloud API endpoints to add an integration to that system. For more details, see [Prisma Cloud Integrations](https://docs.prismacloud.io/en/classic/cspm-admin-guide/configure-external-integrations-on-prisma-cloud/prisma-cloud-integrations). If you are upgraded to the Darwin release, see [Prisma Cloud Integrations](https://docs.prismacloud.io/en/enterprise-edition/content-collections/administration/configure-external-integrations-on-prisma-cloud/prisma-cloud-integrations). + ### AWS Security Hub Prisma Cloud integrates with AWS Security Hub for centralized visibility into security and compliance risks associated with your cloud assets on the AWS Security Hub console. @@ -29,9 +30,9 @@ To add an AWS Security Hub integration, make your request as described in | Key | Value Description | Value Type | Default Value or Required | | -------------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------- | -| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | Array of Objects
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required | -| defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | -| accountId | The Account ID of the AWS account that you have onboarded on Prisma Cloud | string | Required | +| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | List of Objects
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required | +| defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | +| accountId | The Account ID of the AWS account that you have onboarded on Prisma Cloud | string | Required | To update an AWS Security Hub integration, make your request as described in From 940bab0f1ac7c85d9696e1887198fd9b43acc4ca Mon Sep 17 00:00:00 2001 From: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> Date: Fri, 15 Nov 2024 15:49:22 +0530 Subject: [PATCH 3/4] Update api-integration-config.md Signed-off-by: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> --- .../api/cspm/api-integration-config.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/products/prisma-cloud/api/cspm/api-integration-config.md b/products/prisma-cloud/api/cspm/api-integration-config.md index 4059d9cf9..d296faefc 100644 --- a/products/prisma-cloud/api/cspm/api-integration-config.md +++ b/products/prisma-cloud/api/cspm/api-integration-config.md @@ -30,8 +30,8 @@ To add an AWS Security Hub integration, make your request as described in | Key | Value Description | Value Type | Default Value or Required | | -------------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------- | -| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | List of Objects
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required | -| defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name;
String apiIdentifier;
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | +| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | List of Objects
{
String name (Required);
String apiIdentifier(Required);
String cloudType;
String sdkId;
Boolean enabled;
} | Required | +| defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name (Required);
String apiIdentifier (Required);
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | | accountId | The Account ID of the AWS account that you have onboarded on Prisma Cloud | string | Required | @@ -48,37 +48,37 @@ To test an AWS Security Hub, make your request as described in ```json { - "description": "", + "description": "string", "enabled": true, "integrationConfig": { "regions": [ { - "name": "", - "apiIdentifier": "", - "cloudType": "", + "name": "AWS Virginia", + "apiIdentifier": "us-east-1", + "cloudType": "aws", "sdkId": "", "enabled": true }, { - "name": "", - "apiIdentifier": "", - "cloudType": "", - "sdkId": "", + "name": "string", + "apiIdentifier": "string", + "cloudType": "aws", + "sdkId": "integer", "enabled": true } ], "defaultRegion": { - "name": "", - "apiIdentifier": "", - "cloudType": "", - "sdkId": "", + "name": "string", + "apiIdentifier": "string", + "cloudType": "aws", + "sdkId": "integer", "enabled": true }, - "accountId": "" + "accountId": "string" }, - "integrationType": "", - "name": "", - "id": "" + "integrationType": "aws_security_hub", + "name": "string", + "id": "integer" } ``` From b1f77993d4c540391b794d6db0edbd1743315e15 Mon Sep 17 00:00:00 2001 From: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> Date: Fri, 15 Nov 2024 17:05:03 +0530 Subject: [PATCH 4/4] Update api-integration-config.md Signed-off-by: smitapaloalto <156162707+smitapaloalto@users.noreply.github.com> --- products/prisma-cloud/api/cspm/api-integration-config.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/products/prisma-cloud/api/cspm/api-integration-config.md b/products/prisma-cloud/api/cspm/api-integration-config.md index d296faefc..42f3ca0c4 100644 --- a/products/prisma-cloud/api/cspm/api-integration-config.md +++ b/products/prisma-cloud/api/cspm/api-integration-config.md @@ -30,7 +30,7 @@ To add an AWS Security Hub integration, make your request as described in | Key | Value Description | Value Type | Default Value or Required | | -------------- | ----------------------------------------------------------------------------------------------------------------- | ---------- | ------------------------- | -| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | List of Objects
{
String name (Required);
String apiIdentifier(Required);
String cloudType;
String sdkId;
Boolean enabled;
} | Required | +| region | List of Regions where Prisma Cloud on AWS Security Hub is enabled for your cloud account | List of Objects
{
String name; (Required)
String apiIdentifier; (Required)
String cloudType;
String sdkId;
Boolean enabled;
} | Required | | defaultRegion | The region where you will receive alert notifications for global resources | Object
{
String name (Required);
String apiIdentifier (Required);
String cloudType;
String sdkId;
Boolean enabled;
} | Required if the user wants to receive global alerts | | accountId | The Account ID of the AWS account that you have onboarded on Prisma Cloud | string | Required | @@ -63,7 +63,7 @@ To test an AWS Security Hub, make your request as described in "name": "string", "apiIdentifier": "string", "cloudType": "aws", - "sdkId": "integer", + "sdkId": "string", "enabled": true } ], @@ -71,14 +71,14 @@ To test an AWS Security Hub, make your request as described in "name": "string", "apiIdentifier": "string", "cloudType": "aws", - "sdkId": "integer", + "sdkId": "string", "enabled": true }, "accountId": "string" }, "integrationType": "aws_security_hub", "name": "string", - "id": "integer" + "id": "string" } ```