REST Resource: organizations.securityMonitoringConditions

Resource: SecurityMonitoringCondition

Security monitoring condition for risk assessment version 2.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "profile": string,
  "scope": string,
  "totalMonitoredResources": integer,
  "totalDeployedResources": integer,
  "riskAssessmentType": enum (RiskAssessmentType),
  "apiHubGateway": string,

  // Union field resources can be only one of the following:
  "includeAllResources": {
    object (IncludeAll)
  },
  "include": {
    object (ResourceArray)
  }
  // End of list of possible types for union field resources.
}
Fields
name

string

Identifier. Name of the security monitoring condition resource. Format: organizations/{org}/securityMonitoringConditions/{securityMonitoringCondition}

createTime

string (Timestamp format)

Output only. The time of the security monitoring condition 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 monitoring condition 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".

profile

string

Required. ID of security profile of the security monitoring condition.

scope

string

Optional. Scope of the security monitoring condition. When RiskAssessmentType is APIGEE, the scope should be set to the environment of the resources. When RiskAssessmentType is API_HUB, the scope should not be set.

totalMonitoredResources

integer

Output only. Total number of monitored resources within this condition.

totalDeployedResources

integer

Output only. Total number of deployed resources within scope.

riskAssessmentType

enum (RiskAssessmentType)

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

apiHubGateway

string

Optional. The API Hub gateway monitored by the security monitoring condition. This should only be set if riskAssessmentType is API_HUB. Format: projects/{project}/locations/{location}/plugins/{plugin}/instances/{instance}

Union field resources. REQUIRED. resources can be only one of the following:
includeAllResources

object (IncludeAll)

Include all resources under the scope.

include

object (ResourceArray)

Include only these resources.

IncludeAll

This type has no fields.

Message for includeAllResources option.

ResourceArray

Message for the array of resources. For Apigee, the proxies are resources.

JSON representation
{
  "resources": [
    {
      object (Resource)
    }
  ]
}
Fields
resources[]

object (Resource)

Required. The array of resources. For Apigee, the proxies are resources.

Resource

Resource for which we are computing security assessment.

JSON representation
{
  "type": enum (ResourceType),
  "name": string
}
Fields
type

enum (ResourceType)

Required. Type of this resource.

name

string

Required. Name of this resource. For an Apigee API Proxy, this should be the id of the API proxy. For an API Hub Deployment, this should be the id of the deployment.

ResourceType

Type of the resource

Enums
RESOURCE_TYPE_UNSPECIFIED ResourceType not specified.
API_PROXY Resource is an Apigee Proxy.
API_HUB_DEPLOYMENT Resource is an API Hub deployment.

Methods

create

Create a security monitoring condition.

delete

Delete a security monitoring condition.

get

Get a security monitoring condition.

list

List security monitoring conditions.

patch

Update a security monitoring condition.