xref: /aosp_15_r20/external/googleapis/google/cloud/ids/v1/ids_v1.yaml (revision d5c09012810ac0c9f33fe448fb6da8260d444cc9)
1type: google.api.Service
2config_version: 3
3name: ids.googleapis.com
4title: Cloud IDS API
5
6apis:
7- name: google.cloud.ids.v1.IDS
8
9types:
10- name: google.cloud.ids.v1.OperationMetadata
11
12documentation:
13  summary: |-
14    Cloud IDS (Cloud Intrusion Detection System) detects malware, spyware,
15    command-and-control attacks, and other network-based threats. Its security
16    efficacy is industry leading, built with Palo Alto Networks technologies.
17    When you use this product, your organization name and consumption levels
18    will be shared with Palo Alto Networks.
19  rules:
20  - selector: google.cloud.location.Locations.GetLocation
21    description: Gets information about a location.
22
23  - selector: google.cloud.location.Locations.ListLocations
24    description: Lists information about the supported locations for this service.
25
26  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
27    description: |-
28      Gets the access control policy for a resource. Returns an empty policy
29      if the resource exists and does not have a policy set.
30
31  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
32    description: |-
33      Sets the access control policy on the specified resource. Replaces
34      any existing policy.
35
36      Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and `PERMISSION_DENIED`
37      errors.
38
39  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
40    description: |-
41      Returns permissions that a caller has on the specified resource. If the
42      resource does not exist, this will return an empty set of
43      permissions, not a `NOT_FOUND` error.
44
45      Note: This operation is designed to be used for building
46      permission-aware UIs and command-line tools, not for authorization
47      checking. This operation may "fail open" without warning.
48
49backend:
50  rules:
51  - selector: 'google.cloud.ids.v1.IDS.*'
52    deadline: 60.0
53  - selector: google.cloud.location.Locations.GetLocation
54    deadline: 60.0
55  - selector: google.cloud.location.Locations.ListLocations
56    deadline: 60.0
57  - selector: 'google.iam.v1.IAMPolicy.*'
58    deadline: 60.0
59  - selector: 'google.longrunning.Operations.*'
60    deadline: 60.0
61
62http:
63  rules:
64  - selector: google.cloud.location.Locations.GetLocation
65    get: '/v1/{name=projects/*/locations/*}'
66  - selector: google.cloud.location.Locations.ListLocations
67    get: '/v1/{name=projects/*}/locations'
68  - selector: google.iam.v1.IAMPolicy.GetIamPolicy
69    get: '/v1/{resource=projects/*/locations/*/endpoints/*}:getIamPolicy'
70  - selector: google.iam.v1.IAMPolicy.SetIamPolicy
71    post: '/v1/{resource=projects/*/locations/*/endpoints/*}:setIamPolicy'
72    body: '*'
73  - selector: google.iam.v1.IAMPolicy.TestIamPermissions
74    post: '/v1/{resource=projects/*/locations/*/endpoints/*}:testIamPermissions'
75    body: '*'
76  - selector: google.longrunning.Operations.CancelOperation
77    post: '/v1/{name=projects/*/locations/*/operations/*}:cancel'
78    body: '*'
79  - selector: google.longrunning.Operations.DeleteOperation
80    delete: '/v1/{name=projects/*/locations/*/operations/*}'
81  - selector: google.longrunning.Operations.GetOperation
82    get: '/v1/{name=projects/*/locations/*/operations/*}'
83  - selector: google.longrunning.Operations.ListOperations
84    get: '/v1/{name=projects/*/locations/*}/operations'
85
86authentication:
87  rules:
88  - selector: 'google.cloud.ids.v1.IDS.*'
89    oauth:
90      canonical_scopes: |-
91        https://www.googleapis.com/auth/cloud-platform
92  - selector: google.cloud.location.Locations.GetLocation
93    oauth:
94      canonical_scopes: |-
95        https://www.googleapis.com/auth/cloud-platform
96  - selector: google.cloud.location.Locations.ListLocations
97    oauth:
98      canonical_scopes: |-
99        https://www.googleapis.com/auth/cloud-platform
100  - selector: 'google.iam.v1.IAMPolicy.*'
101    oauth:
102      canonical_scopes: |-
103        https://www.googleapis.com/auth/cloud-platform
104  - selector: 'google.longrunning.Operations.*'
105    oauth:
106      canonical_scopes: |-
107        https://www.googleapis.com/auth/cloud-platform
108