Skip to main content

security_actions_config

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

Overview

Namesecurity_actions_config
TypeResource
Idgoogle.apigee.security_actions_config

Fields

The following fields are returned by SELECT queries:

Successful response

NameDatatypeDescription
namestringThis is a singleton resource, the name will always be set by SecurityActions and any user input will be ignored. The name is always: organizations/{org}/environments/{env}/security_actions_config
enabledbooleanThe flag that controls whether this feature is enabled. This is unset by default. When this flag is false, even if individual rules are enabled, no SecurityActions will be enforced.
updateTimestring (google-datetime)Output only. The update time for configuration.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
organizations_environments_get_security_actions_configselectorganizationsId, environmentsIdGetSecurityActionConfig returns the current SecurityActions configuration.
organizations_environments_update_security_actions_configupdateorganizationsId, environmentsIdupdateMaskUpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.

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.

NameDatatypeDescription
environmentsIdstring
organizationsIdstring
updateMaskstring (google-fieldmask)

SELECT examples

GetSecurityActionConfig returns the current SecurityActions configuration.

SELECT
name,
enabled,
updateTime
FROM google.apigee.security_actions_config
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;

UPDATE examples

UpdateSecurityActionConfig updates the current SecurityActions configuration. This method is used to enable/disable the feature at the environment level.

UPDATE google.apigee.security_actions_config
SET
data__name = '{{ name }}',
data__enabled = {{ enabled }}
WHERE
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
enabled,
updateTime;