Cloud Security Compliance

The Cloud Security Compliance service collection provides operations for retrieving compliance posture summaries for cloud environments. Get benchmark section and requirement scores for compliance frameworks or retrieve compliance scores and counts for specific rules.

Language	Last Update
Python	v1.6.5
PowerShell
Go	v0.22.0
TypeScript	v0.6.0
Rust	v0.7.1
Ruby	v1.4.0

Operation	Description
cloud-compliance-framework-posture-summaries `framework_posture_summaries`	Get sections and requirements with scores for benchmarks.
cloud-compliance-rule-posture-summaries `rule_posture_summaries`	Get compliance score and counts for rules.

cloud-compliance-framework-posture-summaries

Get sections and requirements with scores for benchmarks.

Method GET

Route /cloud-security-compliance/entities/framework-posture-summaries/v1

Scope Cloud Security API Assets: READ

PEP 8 framework_posture_summaries

Parameters

ids query · string or list of strings

The uuids of compliance frameworks to retrieve (maximum 20 IDs allowed).

filter query · string

FQL filter, supported properties:

Available values (14)

`account_id`	`account_name`	`business_impact`
`cloud_label`	`cloud_label_id`	`cloud_provider`
`environment`	`groups`	`region`
`resource_type`	`resource_type_name`	`tag_key`
`tag_value`	`tags_string`

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

from falconpy import CloudSecurityCompliance

falcon = CloudSecurityCompliance(client_id=CLIENT_ID,
                                 client_secret=CLIENT_SECRET
                                 )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.framework_posture_summaries(filter="string", ids=id_list)
print(response)

from falconpy import CloudSecurityCompliance

falcon = CloudSecurityCompliance(client_id=CLIENT_ID,
                                 client_secret=CLIENT_SECRET
                                 )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.cloud_compliance_framework_posture_summaries(filter="string",
                                                               ids=id_list)
print(response)

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("cloud_compliance_framework_posture_summaries",
                          ids=id_list,
                          filter="string")
print(response)

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_security_compliance"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  filter := "string"

  response, err := client.CloudSecurityCompliance.CloudComplianceFrameworkPostureSummaries(
    &cloud_security_compliance.CloudComplianceFrameworkPostureSummariesParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Filter: &filter,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.cloudSecurityCompliance.cloudComplianceFrameworkPostureSummaries(
  ["ID1", "ID2", "ID3"],  // ids
  "string"  // filter
);

console.log(response);

use rusty_falcon::apis::cloud_security_compliance_api::cloud_compliance_framework_posture_summaries;
use rusty_falcon::easy::client::FalconHandle;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let response = cloud_compliance_framework_posture_summaries(
        &falcon.cfg,  // configuration
        vec!["string".to_string()],  // ids
        Some("string"),  // filter
    ).await.expect("API call failed");

    println!("{:?}", response);
}

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::CloudSecurityCompliance.new

response = api.cloud_compliance_framework_posture_summaries(['ID1', 'ID2', 'ID3'])

puts response

Responses

[
  {
    "authority": "string",
    "id": "string",
    "name": "string",
    "posture": {},
    "sections": [],
    "version": "string"
  }
]

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

cloud-compliance-rule-posture-summaries

Get compliance score and counts for rules.

Method GET

Route /cloud-security-compliance/entities/rule-posture-summaries/v1

Scope Cloud Security API Assets: READ

PEP 8 rule_posture_summaries

Parameters

ids query · string or list of strings

The uuids of compliance rules to retrieve (maximum 350 IDs allowed).

filter query · string

FQL filter, supported properties:

Available values (14)

`account_id`	`account_name`	`business_impact`
`cloud_label`	`cloud_label_id`	`cloud_provider`
`environment`	`groups`	`region`
`resource_type`	`resource_type_name`	`tag_key`
`tag_value`	`tags_string`

parameters query · dictionary

Full query string parameters payload in JSON format. Not required when using other keywords.

Code Examples

from falconpy import CloudSecurityCompliance

falcon = CloudSecurityCompliance(client_id=CLIENT_ID,
                                 client_secret=CLIENT_SECRET
                                 )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.rule_posture_summaries(filter="string", ids=id_list)
print(response)

from falconpy import CloudSecurityCompliance

falcon = CloudSecurityCompliance(client_id=CLIENT_ID,
                                 client_secret=CLIENT_SECRET
                                 )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.cloud_compliance_rule_posture_summaries(filter="string",
                                                          ids=id_list)
print(response)

from falconpy import APIHarnessV2

falcon = APIHarnessV2(client_id=CLIENT_ID,
                      client_secret=CLIENT_SECRET
                      )

id_list = 'ID1,ID2,ID3'  # Can also pass a list here: ['ID1', 'ID2', 'ID3']

response = falcon.command("cloud_compliance_rule_posture_summaries",
                          ids=id_list,
                          filter="string")
print(response)

package main

import (
  "context"
  "fmt"
  "os"

  "github.com/crowdstrike/gofalcon/falcon"
  "github.com/crowdstrike/gofalcon/falcon/client/cloud_security_compliance"
)

func main() {
  client, err := falcon.NewClient(&falcon.ApiConfig{
    ClientId:     os.Getenv("FALCON_CLIENT_ID"),
    ClientSecret: os.Getenv("FALCON_CLIENT_SECRET"),
    Context:      context.Background(),
  })
  if err != nil {
    panic(err)
  }

  filter := "string"

  response, err := client.CloudSecurityCompliance.CloudComplianceRulePostureSummaries(
    &cloud_security_compliance.CloudComplianceRulePostureSummariesParams{
      Ids: []string{"ID1", "ID2", "ID3"},
      Filter: &filter,
      Context: context.Background(),
    },
  )
  if err != nil {
    panic(falcon.ErrorExplain(err))
  }

  fmt.Printf("%+v\n", response.Payload)
}

import { FalconClient } from "crowdstrike-falcon";

const client = new FalconClient({
  cloud: process.env.FALCON_CLOUD!,
  clientId: process.env.FALCON_CLIENT_ID!,
  clientSecret: process.env.FALCON_CLIENT_SECRET!,
});

const response = await client.cloudSecurityCompliance.cloudComplianceRulePostureSummaries(
  ["ID1", "ID2", "ID3"],  // ids
  "string"  // filter
);

console.log(response);

use rusty_falcon::apis::cloud_security_compliance_api::cloud_compliance_rule_posture_summaries;
use rusty_falcon::easy::client::FalconHandle;

#[tokio::main]
async fn main() {
    let falcon = FalconHandle::from_env().await.expect("Could not authenticate");

    let response = cloud_compliance_rule_posture_summaries(
        &falcon.cfg,  // configuration
        vec!["string".to_string()],  // ids
        Some("string"),  // filter
    ).await.expect("API call failed");

    println!("{:?}", response);
}

require "crimson-falcon"

Falcon.configure do |config|
  config.client_id = ENV["FALCON_CLIENT_ID"]
  config.client_secret = ENV["FALCON_CLIENT_SECRET"]
  config.cloud = ENV["FALCON_CLOUD"]
end

api = Falcon::CloudSecurityCompliance.new

response = api.cloud_compliance_rule_posture_summaries(['ID1', 'ID2', 'ID3'])

puts response

Responses

[
  {
    "id": "string",
    "name": "string",
    "posture": {},
    "provider": "string"
  }
]

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "pagination": {
      "limit": 0,
      "offset": 0,
      "total": 0
    },
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

{
  "errors": [
    {
      "code": 0,
      "id": "string",
      "message": "string"
    }
  ],
  "meta": {
    "next": "string",
    "powered_by": "string",
    "query_time": 0.0,
    "trace_id": "string",
    "writes": {
      "resources_affected": 0
    }
  }
}

Cloud Security Compliance

Table of Contents

cloud-compliance-framework-posture-summaries

Parameters

cloud-compliance-rule-posture-summaries

Parameters