You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dyn/apigee_v1.organizations.appgroups.apps.keys.html
+1-1Lines changed: 1 addition & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -258,7 +258,7 @@ <h3>Method Details</h3>
258
258
"apiProducts": [ # The list of API products that will be associated with the credential. This list will be appended to the existing list of associated API Products for this App Key. Duplicates will be ignored.
259
259
"A String",
260
260
],
261
-
"appGroupAppKey": { # AppGroupAppKey contains all the information associated with the credentials. # Note that only Scopes and Attributes of the AppGroupAppKey can be amended.
261
+
"appGroupAppKey": { # AppGroupAppKey contains all the information associated with the credentials. # Note that only Scopes and Attributes of the AppGroupAppKey can be amended. Scopes and Attributes mentioned in the request will be inserted and the existing scopes and attributes will be removed.
262
262
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
263
263
{ # APIProductAssociation has the API product and its administrative state association.
264
264
"apiproduct": "A String", # API product to be associated with the credential.
<pclass="firstline">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.</p>
name: string, Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/environment/{env}/securityActions/{security_action}` (required)
257
+
x__xgafv: string, V1 error format.
258
+
Allowed values
259
+
1 - v1 error format
260
+
2 - v2 error format
261
+
262
+
Returns:
263
+
An object of the form:
264
+
265
+
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
<pre>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.
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} (required)
613
+
body: object, The request body.
614
+
The object takes the form of:
615
+
616
+
{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction.
617
+
"allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction.
618
+
},
619
+
"apiProxies": [ # 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.
620
+
"A String",
621
+
],
622
+
"conditionConfig": { # 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. # Required. A valid SecurityAction must contain at least one condition.
623
+
"accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action.
624
+
"A String",
625
+
],
626
+
"apiKeys": [ # Optional. A list of API keys. Limit 1000 per action.
627
+
"A String",
628
+
],
629
+
"apiProducts": [ # Optional. A list of API Products. Limit 1000 per action.
630
+
"A String",
631
+
],
632
+
"asns": [ # Optional. A list of ASN numbers to act on, e.g. 23. https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses int64 instead of uint32 because of https://linter.aip.dev/141/forbidden-types.
633
+
"A String",
634
+
],
635
+
"botReasons": [ # Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection, Advanced API Scraper, Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public Cloud Azure, and Public Cloud Google.
636
+
"A String",
637
+
],
638
+
"developerApps": [ # Optional. A list of developer apps. Limit 1000 per action.
639
+
"A String",
640
+
],
641
+
"developers": [ # Optional. A list of developers. Limit 1000 per action.
642
+
"A String",
643
+
],
644
+
"httpMethods": [ # Optional. Act only on particular HTTP methods. E.g. A read-only API can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH.
645
+
"A String",
646
+
],
647
+
"ipAddressRanges": [ # Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
648
+
"A String",
649
+
],
650
+
"regionCodes": [ # Optional. A list of countries/region codes to act on, e.g. US. This follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
651
+
"A String",
652
+
],
653
+
"userAgents": [ # Optional. A list of user agents to deny. We look for exact matches. Limit 50 per action.
654
+
"A String",
655
+
],
656
+
},
657
+
"createTime": "A String", # Output only. The create time for this SecurityAction.
658
+
"deny": { # Message that should be set in case of a Deny Action. # Deny a request through if it matches this SecurityAction.
659
+
"responseCode": 42, # Optional. The HTTP response code if the Action = DENY.
660
+
},
661
+
"description": "A String", # Optional. An optional user provided description of the SecurityAction.
662
+
"expireTime": "A String", # The expiration for this SecurityAction.
663
+
"flag": { # The message that should be set in the case of a Flag action. # Flag a request through if it matches this SecurityAction.
664
+
"headers": [ # Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
665
+
{ # An HTTP header.
666
+
"name": "A String", # The header name to be sent to the target.
667
+
"value": "A String", # The header value to be sent to the target.
668
+
},
669
+
],
670
+
},
671
+
"name": "A 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}
672
+
"state": "A String", # Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
673
+
"ttl": "A String", # Input only. The TTL for this SecurityAction.
674
+
"updateTime": "A String", # Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.
675
+
}
676
+
677
+
updateMask: string, Optional. The list of fields to update. Valid fields to update are `description`, `state`, `allow`, `deny`, and `flag`, `expire_time`, and `ttl`, `api_proxies`, and `condition_config`.
678
+
x__xgafv: string, V1 error format.
679
+
Allowed values
680
+
1 - v1 error format
681
+
2 - v2 error format
682
+
683
+
Returns:
684
+
An object of the form:
685
+
686
+
{ # A SecurityAction is rule that can be enforced at an environment level. The result is one of: - A denied API call - An explicitly allowed API call - A flagged API call (HTTP headers added before the target receives it) At least one condition is required to create a SecurityAction.
687
+
"allow": { # Message that should be set in case of an Allow Action. This does not have any fields. # Allow a request through if it matches this SecurityAction.
688
+
},
689
+
"apiProxies": [ # 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.
690
+
"A String",
691
+
],
692
+
"conditionConfig": { # 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. # Required. A valid SecurityAction must contain at least one condition.
693
+
"accessTokens": [ # Optional. A list of access_tokens. Limit 1000 per action.
694
+
"A String",
695
+
],
696
+
"apiKeys": [ # Optional. A list of API keys. Limit 1000 per action.
697
+
"A String",
698
+
],
699
+
"apiProducts": [ # Optional. A list of API Products. Limit 1000 per action.
700
+
"A String",
701
+
],
702
+
"asns": [ # Optional. A list of ASN numbers to act on, e.g. 23. https://en.wikipedia.org/wiki/Autonomous_system_(Internet) This uses int64 instead of uint32 because of https://linter.aip.dev/141/forbidden-types.
703
+
"A String",
704
+
],
705
+
"botReasons": [ # Optional. A list of Bot Reasons. Current options: Flooder, Brute Guessor, Static Content Scraper, OAuth Abuser, Robot Abuser, TorListRule, Advanced Anomaly Detection, Advanced API Scraper, Search Engine Crawlers, Public Clouds, Public Cloud AWS, Public Cloud Azure, and Public Cloud Google.
706
+
"A String",
707
+
],
708
+
"developerApps": [ # Optional. A list of developer apps. Limit 1000 per action.
709
+
"A String",
710
+
],
711
+
"developers": [ # Optional. A list of developers. Limit 1000 per action.
712
+
"A String",
713
+
],
714
+
"httpMethods": [ # Optional. Act only on particular HTTP methods. E.g. A read-only API can block POST/PUT/DELETE methods. Accepted values are: GET, HEAD, POST, PUT, DELETE, CONNECT, OPTIONS, TRACE and PATCH.
715
+
"A String",
716
+
],
717
+
"ipAddressRanges": [ # Optional. A list of IP addresses. This could be either IPv4 or IPv6. Limited to 100 per action.
718
+
"A String",
719
+
],
720
+
"regionCodes": [ # Optional. A list of countries/region codes to act on, e.g. US. This follows https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2.
721
+
"A String",
722
+
],
723
+
"userAgents": [ # Optional. A list of user agents to deny. We look for exact matches. Limit 50 per action.
724
+
"A String",
725
+
],
726
+
},
727
+
"createTime": "A String", # Output only. The create time for this SecurityAction.
728
+
"deny": { # Message that should be set in case of a Deny Action. # Deny a request through if it matches this SecurityAction.
729
+
"responseCode": 42, # Optional. The HTTP response code if the Action = DENY.
730
+
},
731
+
"description": "A String", # Optional. An optional user provided description of the SecurityAction.
732
+
"expireTime": "A String", # The expiration for this SecurityAction.
733
+
"flag": { # The message that should be set in the case of a Flag action. # Flag a request through if it matches this SecurityAction.
734
+
"headers": [ # Optional. A list of HTTP headers to be sent to the target in case of a FLAG SecurityAction. Limit 5 headers per SecurityAction. At least one is mandatory.
735
+
{ # An HTTP header.
736
+
"name": "A String", # The header name to be sent to the target.
737
+
"value": "A String", # The header value to be sent to the target.
738
+
},
739
+
],
740
+
},
741
+
"name": "A 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}
742
+
"state": "A String", # Required. Only an ENABLED SecurityAction is enforced. An ENABLED SecurityAction past its expiration time will not be enforced.
743
+
"ttl": "A String", # Input only. The TTL for this SecurityAction.
744
+
"updateTime": "A String", # Output only. The update time for this SecurityAction. This reflects when this SecurityAction changed states.
"description": "Required. The name of the security monitoring condition to delete. Format: `organizations/{org}/environment/{env}/securityActions/{security_action}`",
"description": "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.",
"description": "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": "Optional. The list of fields to update. Valid fields to update are `description`, `state`, `allow`, `deny`, and `flag`, `expire_time`, and `ttl`, `api_proxies`, and `condition_config`.",
7225
+
"format": "google-fieldmask",
7226
+
"location": "query",
7227
+
"type": "string"
7228
+
}
7229
+
},
7230
+
"path": "v1/{+name}",
7231
+
"request": {
7232
+
"$ref": "GoogleCloudApigeeV1SecurityAction"
7233
+
},
7234
+
"response": {
7235
+
"$ref": "GoogleCloudApigeeV1SecurityAction"
7236
+
},
7237
+
"scopes": [
7238
+
"https://www.googleapis.com/auth/cloud-platform"
7239
+
]
7181
7240
}
7182
7241
}
7183
7242
},
@@ -11063,7 +11122,7 @@
11063
11122
}
11064
11123
}
11065
11124
},
11066
-
"revision": "20250614",
11125
+
"revision": "20250622",
11067
11126
"rootUrl": "https://apigee.googleapis.com/",
11068
11127
"schemas": {
11069
11128
"EdgeConfigstoreBundleBadBundle": {
@@ -19551,7 +19610,7 @@
19551
19610
},
19552
19611
"appGroupAppKey": {
19553
19612
"$ref": "GoogleCloudApigeeV1AppGroupAppKey",
19554
-
"description": "Note that only Scopes and Attributes of the AppGroupAppKey can be amended."
19613
+
"description": "Note that only Scopes and Attributes of the AppGroupAppKey can be amended. Scopes and Attributes mentioned in the request will be inserted and the existing scopes and attributes will be removed."
0 commit comments