REST Resource: organizations.securityProfilesV2

Resource: SecurityProfileV2

Security profile for risk assessment version 2.

JSON representation 
{
  "name": string,
  "description": string,
  "createTime": string,
  "updateTime": string,
  "profileAssessmentConfigs": {
    string: {
      object (ProfileAssessmentConfig)
    },
    ...
  },
  "googleDefined": boolean,
  "riskAssessmentType": enum (RiskAssessmentType)
}
Fields
name

string

Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}
description

string

Optional. The description of the security profile.
createTime

string (Timestamp format)

Output only. The time of the security profile creation.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
updateTime

string (Timestamp format)

Output only. The time of the security profile update.

Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
profileAssessmentConfigs

map (key: string, value: object (ProfileAssessmentConfig))

Required. The configuration for each assessment in this profile. Key is the name/id of the assessment.

An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
googleDefined

boolean

Output only. Whether the security profile is google defined.
riskAssessmentType

enum (RiskAssessmentType)

Optional. The risk assessment type of the security profile. Defaults to ADVANCED_API_SECURITY.

ProfileAssessmentConfig

The configuration definition for a specific assessment.

JSON representation 
{
  "weight": enum (Weight),

  // Union field api_hub_gateway_types can be only one of the following:
  "include": {
    object (ApiHubGatewayTypeArray)
  }
  // End of list of possible types for union field api_hub_gateway_types.
}
Fields
weight

enum (Weight)

The weight of the assessment.
Union field api_hub_gateway_types. The gateway types that will be assessed. api_hub_gateway_types can be only one of the following:
include

object (ApiHubGatewayTypeArray)

Include only these Gateway Types.

Weight

The weight of the assessment.

Enums
WEIGHT_UNSPECIFIED The weight is unspecified.
MINOR The weight is minor.
MODERATE The weight is moderate.
MAJOR The weight is major.

ApiHubGatewayTypeArray

Message for the array of API Hub Gateway Types.

JSON representation 
{
  "gatewayTypes": [
    enum (ApiHubGatewayType)
  ]
}
Fields
gatewayTypes[]

enum (ApiHubGatewayType)

Required. The array of API Hub Gateway Types.

ApiHubGatewayType

ApiHubGateway type.

Enums
API_HUB_GATEWAY_TYPE_UNSPECIFIED Gateway type is not specified.
APIGEE_X Gateway is Apigee X for API Hub.
APIGEE_HYBRID Gateway is Apigee Hybrid for API Hub.
APIGEE_EDGE Gateway is Apigee Edge for API Hub.
APIGEE_OPDK Gateway is Apigee OPDK for API Hub.

RiskAssessmentType

Risk assessment type.

Enums
RISK_ASSESSMENT_TYPE_UNSPECIFIED Risk assessment type is not specified.
APIGEE Risk assessment type is Apigee.
API_HUB Risk assessment type is API Hub.

Methods

create

 Create a security profile v2.

delete

 Delete a security profile v2.

get

 Get a security profile v2.

list

 List security profiles v2.

patch

 Update a security profile V2.