security_settings
Creates, updates, deletes, gets or lists a security_settings
resource.
Overview
Name | security_settings |
Type | Resource |
Id | google.apigee.security_settings |
Fields
The following fields are returned by SELECT
queries:
- organizations_get_security_settings
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Identifier. Full resource name is always organizations/{org}/securitySettings . |
mlRetrainingFeedbackEnabled | boolean | Optional. If true the user consents to the use of ML models for Abuse detection. |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
organizations_get_security_settings | select | organizationsId | GetSecuritySettings gets the security settings for API Security. | |
organizations_update_security_settings | update | organizationsId | updateMask | UpdateSecuritySettings updates the current security settings for API Security. |
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 | |
updateMask | string (google-fieldmask) |
SELECT
examples
- organizations_get_security_settings
GetSecuritySettings gets the security settings for API Security.
SELECT
name,
mlRetrainingFeedbackEnabled
FROM google.apigee.security_settings
WHERE organizationsId = '{{ organizationsId }}' -- required;
UPDATE
examples
- organizations_update_security_settings
UpdateSecuritySettings updates the current security settings for API Security.
UPDATE google.apigee.security_settings
SET
data__name = '{{ name }}',
data__mlRetrainingFeedbackEnabled = {{ mlRetrainingFeedbackEnabled }}
WHERE
organizationsId = '{{ organizationsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
name,
mlRetrainingFeedbackEnabled;