security_profiles_v2

Creates, updates, deletes, gets or lists a security_profiles_v2 resource.

Overview

Name	security_profiles_v2
Type	Resource
Id	google.apigee.security_profiles_v2

Fields

The following fields are returned by SELECT queries:

organizations_security_profiles_v2_get

Name	Datatype	Description
name	string	Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}
createTime	string (google-datetime)	Output only. The time of the security profile creation.
description	string	Optional. The description of the security profile.
googleDefined	boolean	Output only. Whether the security profile is google defined.
profileAssessmentConfigs	object	Required. The configuration for each assessment in this profile. Key is the name/id of the assessment.
riskAssessmentType	string	Optional. The risk assessment type of the security profile. Defaults to ADVANCED_API_SECURITY.
updateTime	string (google-datetime)	Output only. The time of the security profile update.

organizations_security_profiles_v2_list

Name	Datatype	Description
name	string	Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}
createTime	string (google-datetime)	Output only. The time of the security profile creation.
description	string	Optional. The description of the security profile.
googleDefined	boolean	Output only. Whether the security profile is google defined.
profileAssessmentConfigs	object	Required. The configuration for each assessment in this profile. Key is the name/id of the assessment.
riskAssessmentType	string	Optional. The risk assessment type of the security profile. Defaults to ADVANCED_API_SECURITY.
updateTime	string (google-datetime)	Output only. The time of the security profile update.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_security_profiles_v2_get	select	organizationsId, securityProfilesV2Id	riskAssessmentType	Get a security profile v2.
organizations_security_profiles_v2_list	select	organizationsId	pageSize, pageToken, riskAssessmentType	List security profiles v2.
organizations_security_profiles_v2_create	insert	organizationsId	securityProfileV2Id	Create a security profile v2.
organizations_security_profiles_v2_patch	update	organizationsId, securityProfilesV2Id	updateMask	Update a security profile V2.
organizations_security_profiles_v2_delete	delete	organizationsId, securityProfilesV2Id	riskAssessmentType	Delete a security profile v2.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
organizationsId	string
securityProfilesV2Id	string
pageSize	integer (int32)
pageToken	string
riskAssessmentType	string
securityProfileV2Id	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_security_profiles_v2_get

Get a security profile v2.

SELECT
name,
createTime,
description,
googleDefined,
profileAssessmentConfigs,
riskAssessmentType,
updateTime
FROM google.apigee.security_profiles_v2
WHERE organizationsId = '{{ organizationsId }}' -- required
AND securityProfilesV2Id = '{{ securityProfilesV2Id }}' -- required
AND riskAssessmentType = '{{ riskAssessmentType }}'
;

organizations_security_profiles_v2_list

List security profiles v2.

SELECT
name,
createTime,
description,
googleDefined,
profileAssessmentConfigs,
riskAssessmentType,
updateTime
FROM google.apigee.security_profiles_v2
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}'
AND riskAssessmentType = '{{ riskAssessmentType }}'
;

INSERT examples

organizations_security_profiles_v2_create

Create a security profile v2.

INSERT INTO google.apigee.security_profiles_v2 (
data__description,
data__profileAssessmentConfigs,
data__riskAssessmentType,
data__name,
organizationsId,
securityProfileV2Id
)
SELECT 
'{{ description }}',
'{{ profileAssessmentConfigs }}',
'{{ riskAssessmentType }}',
'{{ name }}',
'{{ organizationsId }}',
'{{ securityProfileV2Id }}'
RETURNING
name,
createTime,
description,
googleDefined,
profileAssessmentConfigs,
riskAssessmentType,
updateTime
;

Manifest

# Description fields are for documentation purposes
- name: security_profiles_v2
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the security_profiles_v2 resource.
    - name: description
      value: string
      description: >
        Optional. The description of the security profile.
        
    - name: profileAssessmentConfigs
      value: object
      description: >
        Required. The configuration for each assessment in this profile. Key is the name/id of the assessment.
        
    - name: riskAssessmentType
      value: string
      description: >
        Optional. The risk assessment type of the security profile. Defaults to ADVANCED_API_SECURITY.
        
      valid_values: ['RISK_ASSESSMENT_TYPE_UNSPECIFIED', 'APIGEE', 'API_HUB']
    - name: name
      value: string
      description: >
        Identifier. Name of the security profile v2 resource. Format: organizations/{org}/securityProfilesV2/{profile}
        
    - name: securityProfileV2Id
      value: string

UPDATE examples

organizations_security_profiles_v2_patch

Update a security profile V2.

UPDATE google.apigee.security_profiles_v2
SET 
data__description = '{{ description }}',
data__profileAssessmentConfigs = '{{ profileAssessmentConfigs }}',
data__riskAssessmentType = '{{ riskAssessmentType }}',
data__name = '{{ name }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND securityProfilesV2Id = '{{ securityProfilesV2Id }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
createTime,
description,
googleDefined,
profileAssessmentConfigs,
riskAssessmentType,
updateTime;

DELETE examples

organizations_security_profiles_v2_delete

Delete a security profile v2.

DELETE FROM google.apigee.security_profiles_v2
WHERE organizationsId = '{{ organizationsId }}' --required
AND securityProfilesV2Id = '{{ securityProfilesV2Id }}' --required
AND riskAssessmentType = '{{ riskAssessmentType }}'
;