security_profiles

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

Overview

Name	security_profiles
Type	Resource
Id	google.apigee.security_profiles

Fields

The following fields are returned by SELECT queries:

organizations_security_profiles_get

Successful response

Name	Datatype	Description
name	string	Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
description	string	Description of the security profile.
displayName	string	DEPRECATED: DO NOT USE Display name of the security profile.
environments	array	List of environments attached to security profile.
maxScore	integer (int32)	Output only. Maximum security score that can be generated by this profile.
minScore	integer (int32)	Output only. Minimum security score that can be generated by this profile.
profileConfig	object	Required. Customized profile configuration that computes the security score. (id: GoogleCloudApigeeV1ProfileConfig)
revisionCreateTime	string (google-datetime)	Output only. The time when revision was created.
revisionId	string (int64)	Output only. Revision ID of the security profile.
revisionPublishTime	string (google-datetime)	Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
revisionUpdateTime	string (google-datetime)	Output only. The time when revision was updated.
scoringConfigs	array	List of profile scoring configs in this revision.

organizations_security_profiles_list

Successful response

Name	Datatype	Description
name	string	Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
description	string	Description of the security profile.
displayName	string	DEPRECATED: DO NOT USE Display name of the security profile.
environments	array	List of environments attached to security profile.
maxScore	integer (int32)	Output only. Maximum security score that can be generated by this profile.
minScore	integer (int32)	Output only. Minimum security score that can be generated by this profile.
profileConfig	object	Required. Customized profile configuration that computes the security score. (id: GoogleCloudApigeeV1ProfileConfig)
revisionCreateTime	string (google-datetime)	Output only. The time when revision was created.
revisionId	string (int64)	Output only. Revision ID of the security profile.
revisionPublishTime	string (google-datetime)	Output only. DEPRECATED: DO NOT USE The time when revision was published. Once published, the security profile revision cannot be updated further and can be attached to environments.
revisionUpdateTime	string (google-datetime)	Output only. The time when revision was updated.
scoringConfigs	array	List of profile scoring configs in this revision.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
organizations_security_profiles_get	select	organizationsId, securityProfilesId		GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.
organizations_security_profiles_list	select	organizationsId	pageSize, pageToken	ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
organizations_security_profiles_create	insert	organizationsId	securityProfileId	CreateSecurityProfile create a new custom security profile.
organizations_security_profiles_patch	update	organizationsId, securityProfilesId	updateMask	UpdateSecurityProfile update the metadata of security profile.
organizations_security_profiles_delete	delete	organizationsId, securityProfilesId		DeleteSecurityProfile delete a profile with all its revisions.

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
securityProfilesId	string
pageSize	integer (int32)
pageToken	string
securityProfileId	string
updateMask	string (google-fieldmask)

SELECT examples

organizations_security_profiles_get

GetSecurityProfile gets the specified security profile. Returns NOT_FOUND if security profile is not present for the specified organization.

SELECT
name,
description,
displayName,
environments,
maxScore,
minScore,
profileConfig,
revisionCreateTime,
revisionId,
revisionPublishTime,
revisionUpdateTime,
scoringConfigs
FROM google.apigee.security_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND securityProfilesId = '{{ securityProfilesId }}' -- required;

organizations_security_profiles_list

ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.

SELECT
name,
description,
displayName,
environments,
maxScore,
minScore,
profileConfig,
revisionCreateTime,
revisionId,
revisionPublishTime,
revisionUpdateTime,
scoringConfigs
FROM google.apigee.security_profiles
WHERE organizationsId = '{{ organizationsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';

INSERT examples

organizations_security_profiles_create

CreateSecurityProfile create a new custom security profile.

INSERT INTO google.apigee.security_profiles (
data__name,
data__displayName,
data__scoringConfigs,
data__environments,
data__profileConfig,
data__description,
organizationsId,
securityProfileId
)
SELECT 
'{{ name }}',
'{{ displayName }}',
'{{ scoringConfigs }}',
'{{ environments }}',
'{{ profileConfig }}',
'{{ description }}',
'{{ organizationsId }}',
'{{ securityProfileId }}'
RETURNING
name,
description,
displayName,
environments,
maxScore,
minScore,
profileConfig,
revisionCreateTime,
revisionId,
revisionPublishTime,
revisionUpdateTime,
scoringConfigs
;

Manifest

# Description fields are for documentation purposes
- name: security_profiles
  props:
    - name: organizationsId
      value: string
      description: Required parameter for the security_profiles resource.
    - name: name
      value: string
      description: >
        Immutable. Name of the security profile resource. Format: organizations/{org}/securityProfiles/{profile}
        
    - name: displayName
      value: string
      description: >
        DEPRECATED: DO NOT USE Display name of the security profile.
        
    - name: scoringConfigs
      value: array
      description: >
        List of profile scoring configs in this revision.
        
    - name: environments
      value: array
      description: >
        List of environments attached to security profile.
        
    - name: profileConfig
      value: object
      description: >
        Required. Customized profile configuration that computes the security score.
        
    - name: description
      value: string
      description: >
        Description of the security profile.
        
    - name: securityProfileId
      value: string

UPDATE examples

organizations_security_profiles_patch

UpdateSecurityProfile update the metadata of security profile.

UPDATE google.apigee.security_profiles
SET 
data__name = '{{ name }}',
data__displayName = '{{ displayName }}',
data__scoringConfigs = '{{ scoringConfigs }}',
data__environments = '{{ environments }}',
data__profileConfig = '{{ profileConfig }}',
data__description = '{{ description }}'
WHERE 
organizationsId = '{{ organizationsId }}' --required
AND securityProfilesId = '{{ securityProfilesId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
description,
displayName,
environments,
maxScore,
minScore,
profileConfig,
revisionCreateTime,
revisionId,
revisionPublishTime,
revisionUpdateTime,
scoringConfigs;

DELETE examples

organizations_security_profiles_delete

DeleteSecurityProfile delete a profile with all its revisions.

DELETE FROM google.apigee.security_profiles
WHERE organizationsId = '{{ organizationsId }}' --required
AND securityProfilesId = '{{ securityProfilesId }}' --required;