security_actions

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

Overview

Name	security_actions
Type	Resource
Id	google.apigee.security_actions

Fields

Name	Datatype	Description
name	string	Immutable. This field is ignored during creation as per AIP-133. Please set the security_action_id field in the CreateSecurityActionRequest when creating a new SecurityAction. Format: organizations/{org}/environments/{env}/securityActions/{security_action}
description	string	Optional. An optional user provided description of the SecurityAction.
allow	object	Message that should be set in case of an Allow Action. This does not have any fields.
apiProxies	array	Optional. If unset, this would apply to all proxies in the environment. If set, this action is enforced only if at least one proxy in the repeated list is deployed at the time of enforcement. If set, several restrictions are enforced on SecurityActions. There can be at most 100 enabled actions with proxies set in an env. Several other restrictions apply on conditions and are detailed later.
conditionConfig	object	The following are a list of conditions. A valid SecurityAction must contain at least one condition. Within a condition, each element is ORed. Across conditions elements are ANDed. For example if a SecurityAction has the following: ip_address_ranges: ["ip1", "ip2"] and bot_reasons: ["Flooder", "Robot Abuser"] then this is interpreted as: enforce the action if the incoming request has ((ip_address_ranges = "ip1" OR ip_address_ranges = "ip2") AND (bot_reasons="Flooder" OR bot_reasons="Robot Abuser")). Conditions other than ip_address_ranges and bot_reasons cannot be ANDed.
createTime	string	Output only. The create time for this SecurityAction.
deny	object	Message that should be set in case of a Deny Action.
expireTime	string	The expiration for this SecurityAction.
flag	object	The message that should be set in the case of a Flag action.
state	string	Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
ttl	string	Input only. The TTL for this SecurityAction.
updateTime	string	Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.

Methods

Name	Accessible by	Required Params	Description
organizations_environments_security_actions_get	SELECT	environmentsId, organizationsId, securityActionsId	Get a SecurityAction by name.
organizations_environments_security_actions_list	SELECT	environmentsId, organizationsId	Returns a list of SecurityActions. This returns both enabled and disabled actions.
organizations_environments_security_actions_create	INSERT	environmentsId, organizationsId	CreateSecurityAction creates a SecurityAction.
organizations_environments_security_actions_disable	EXEC	environmentsId, organizationsId, securityActionsId	Disable a SecurityAction. The state of the SecurityAction after disabling is DISABLED. DisableSecurityAction can be called on SecurityActions in the state ENABLED; SecurityActions in a different state (including DISABLED) return an error.
organizations_environments_security_actions_enable	EXEC	environmentsId, organizationsId, securityActionsId	Enable a SecurityAction. The state of the SecurityAction after enabling is ENABLED. EnableSecurityAction can be called on SecurityActions in the state DISABLED; SecurityActions in a different state (including `ENABLED) return an error.

SELECT examples

Returns a list of SecurityActions. This returns both enabled and disabled actions.

SELECT
name,
description,
allow,
apiProxies,
conditionConfig,
createTime,
deny,
expireTime,
flag,
state,
ttl,
updateTime
FROM google.apigee.security_actions
WHERE environmentsId = '{{ environmentsId }}'
AND organizationsId = '{{ organizationsId }}';

INSERT example

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

All Properties

/*+ create */
INSERT INTO google.apigee.security_actions (
environmentsId,
organizationsId,
state,
conditionConfig,
allow,
name,
description,
deny,
ttl,
flag,
expireTime,
apiProxies
)
SELECT 
'{{ environmentsId }}',
'{{ organizationsId }}',
'{{ state }}',
'{{ conditionConfig }}',
'{{ allow }}',
'{{ name }}',
'{{ description }}',
'{{ deny }}',
'{{ ttl }}',
'{{ flag }}',
'{{ expireTime }}',
'{{ apiProxies }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: state
      value: string
    - name: conditionConfig
      value:
        - name: apiKeys
          value:
            - string
        - name: httpMethods
          value:
            - string
        - name: developers
          value:
            - string
        - name: apiProducts
          value:
            - string
        - name: ipAddressRanges
          value:
            - string
        - name: botReasons
          value:
            - string
        - name: asns
          value:
            - string
        - name: developerApps
          value:
            - string
        - name: regionCodes
          value:
            - string
        - name: accessTokens
          value:
            - string
        - name: userAgents
          value:
            - string
    - name: allow
      value: []
    - name: name
      value: string
    - name: description
      value: string
    - name: deny
      value:
        - name: responseCode
          value: integer
    - name: createTime
      value: string
    - name: ttl
      value: string
    - name: updateTime
      value: string
    - name: flag
      value:
        - name: headers
          value:
            - - name: value
                value: string
              - name: name
                value: string
    - name: expireTime
      value: string
    - name: apiProxies
      value:
        - string