security_profiles

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

Overview

Name	security_profiles
Type	Resource
Id	google.apigee.security_profiles

Fields

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	Output only. Maximum security score that can be generated by this profile.
minScore	integer	Output only. Minimum security score that can be generated by this profile.
profileConfig	object	ProfileConfig defines a set of categories and policies which will be used to compute security score.
revisionCreateTime	string	Output only. The time when revision was created.
revisionId	string	Output only. Revision ID of the security profile.
revisionPublishTime	string	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	Output only. The time when revision was updated.
scoringConfigs	array	List of profile scoring configs in this revision.

Methods

Name	Accessible by	Required 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	ListSecurityProfiles lists all the security profiles associated with the org including attached and unattached profiles.
organizations_security_profiles_create	INSERT	organizationsId	CreateSecurityProfile create a new custom security profile.
organizations_security_profiles_delete	DELETE	organizationsId, securityProfilesId	DeleteSecurityProfile delete a profile with all its revisions.
organizations_security_profiles_patch	UPDATE	organizationsId, securityProfilesId	UpdateSecurityProfile update the metadata of security profile.

SELECT examples

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 }}';

INSERT example

Use the following StackQL query and manifest file to create a new security_profiles resource.

All Properties

/*+ create */
INSERT INTO google.apigee.security_profiles (
organizationsId,
scoringConfigs,
profileConfig,
displayName,
name,
description,
environments
)
SELECT 
'{{ organizationsId }}',
'{{ scoringConfigs }}',
'{{ profileConfig }}',
'{{ displayName }}',
'{{ name }}',
'{{ description }}',
'{{ environments }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: scoringConfigs
      value:
        - - name: description
            value: string
          - name: title
            value: string
          - name: scorePath
            value: string
    - name: profileConfig
      value:
        - name: categories
          value:
            - - name: abuse
                value: []
              - name: threat
                value: []
              - name: mediation
                value: []
              - name: mtls
                value: []
              - name: cors
                value: []
              - name: authorization
                value: []
    - name: displayName
      value: string
    - name: revisionPublishTime
      value: string
    - name: minScore
      value: integer
    - name: revisionId
      value: string
    - name: name
      value: string
    - name: description
      value: string
    - name: maxScore
      value: integer
    - name: environments
      value:
        - - name: environment
            value: string
          - name: attachTime
            value: string
    - name: revisionCreateTime
      value: string
    - name: revisionUpdateTime
      value: string

UPDATE example

Updates a security_profiles resource.

/*+ update */
UPDATE google.apigee.security_profiles
SET 
scoringConfigs = '{{ scoringConfigs }}',
profileConfig = '{{ profileConfig }}',
displayName = '{{ displayName }}',
name = '{{ name }}',
description = '{{ description }}',
environments = '{{ environments }}'
WHERE 
organizationsId = '{{ organizationsId }}'
AND securityProfilesId = '{{ securityProfilesId }}';

DELETE example

Deletes the specified security_profiles resource.

/*+ delete */
DELETE FROM google.apigee.security_profiles
WHERE organizationsId = '{{ organizationsId }}'
AND securityProfilesId = '{{ securityProfilesId }}';