REST Resource: organizations.locations.frameworks

Resource: Framework

A framework is a collection of cloud controls and regulatory controls that represent security best practices or industry-defined standards such as FedRAMP or NIST.

JSON representation 
{
  "name": string,
  "majorRevisionId": string,
  "displayName": string,
  "description": string,
  "type": enum (FrameworkType),
  "cloudControlDetails": [
    {
      object (CloudControlDetails)
    }
  ],
  "category": [
    enum (FrameworkCategory)
  ],
  "supportedCloudProviders": [
    enum (CloudProvider)
  ],
  "supportedTargetResourceTypes": [
    enum (TargetResourceType)
  ],
  "supportedEnforcementModes": [
    enum (EnforcementMode)
  ]
}
Fields
name

string

Required. Identifier. The name of the framework, in the format organizations/{organization}/locations/{location}/frameworks/{frameworkId}. The only supported location is global.
majorRevisionId

string (int64 format)

Output only. The major version of the framework, which is incremented in ascending order.
displayName

string

Optional. The friendly name of the framework. The maximum length is 200 characters.
description

string

Optional. The description of the framework. The maximum length is 2000 characters.
type

enum (FrameworkType)

Output only. The type of framework.
cloudControlDetails[]

object (CloudControlDetails)

Optional. The cloud control details that are directly added without any grouping in the framework.
category[]

enum (FrameworkCategory)

Optional. The category of the framework.
supportedCloudProviders[]

enum (CloudProvider)

Output only. The cloud providers that are supported by the framework.
supportedTargetResourceTypes[]

enum (TargetResourceType)

Output only. The target resource types that are supported by the framework.
supportedEnforcementModes[]

enum (EnforcementMode)

Output only. The supported enforcement modes of the framework.

FrameworkType

The type of framework.

Enums
FRAMEWORK_TYPE_UNSPECIFIED Default value. This value is unused.
BUILT_IN A framework that's provided and managed by Google.
CUSTOM A framework that's created and managed by you.

FrameworkCategory

The category for the framework.

Enums
FRAMEWORK_CATEGORY_UNSPECIFIED Default value. This value is unused.
INDUSTRY_DEFINED_STANDARD An industry-defined framework.
ASSURED_WORKLOADS An Assured Workloads framework.
DATA_SECURITY A data security posture framework.
GOOGLE_BEST_PRACTICES A Google's best practices framework.
CUSTOM_FRAMEWORK A user-created framework.

Methods

create

 Creates a custom framework in a given parent resource.

delete

 Deletes a custom framework, including all its major and minor revisions.

get

 Gets details about a framework.

list

 Lists the frameworks (both built-in and custom) that are available within the parent resource.

patch

 Updates a custom framework.