blob: 1387dee3554d85047d24f91a3f3aa63e81ae7f02 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -07001<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="accesscontextmanager_v1.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1.accessPolicies.html">accessPolicies</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="accesscontextmanager_v1.accessPolicies.accessLevels.html">accessLevels()</a></code>
79</p>
80<p class="firstline">Returns the accessLevels Resource.</p>
81
82<p class="toc_element">
83 <code><a href="accesscontextmanager_v1.accessPolicies.servicePerimeters.html">servicePerimeters()</a></code>
84</p>
85<p class="firstline">Returns the servicePerimeters Resource.</p>
86
87<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -070088 <code><a href="#create">create(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070089<p class="firstline">Create an `AccessPolicy`. Fails if this organization already has a</p>
90<p class="toc_element">
91 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
92<p class="firstline">Delete an AccessPolicy by resource</p>
93<p class="toc_element">
94 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
95<p class="firstline">Get an AccessPolicy by name.</p>
96<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070097 <code><a href="#list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -070098<p class="firstline">List all AccessPolicies under a</p>
99<p class="toc_element">
100 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
101<p class="firstline">Retrieves the next page of results.</p>
102<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700103 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700104<p class="firstline">Update an AccessPolicy. The</p>
105<h3>Method Details</h3>
106<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700107 <code class="details" id="create">create(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700108 <pre>Create an `AccessPolicy`. Fails if this organization already has a
109`AccessPolicy`. The longrunning Operation will have a successful status
110once the `AccessPolicy` has propagated to long-lasting storage.
111Syntactic and basic semantic errors will be returned in `metadata` as a
112BadRequest proto.
113
114Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700115 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700116 The object takes the form of:
117
118{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim65020912020-05-20 12:08:20 -0700119 # attributes to use Google Cloud services) and `ServicePerimeters` (which
120 # define regions of services able to freely pass data within a perimeter). An
121 # access policy is globally visible within an organization, and the
122 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim65020912020-05-20 12:08:20 -0700123 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
124 # Hierarchy. Currently immutable once created. Format:
125 # `organizations/{organization_id}`
126 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700127 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the
128 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
129 # two Access Polices will be identical if and only if their etags are
130 # identical. Clients should not expect this to be in any specific format.
131 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
132 # `accessPolicies/{policy_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700133}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700134
135 x__xgafv: string, V1 error format.
136 Allowed values
137 1 - v1 error format
138 2 - v2 error format
139
140Returns:
141 An object of the form:
142
143 { # This resource represents a long-running operation that is the result of a
144 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700145 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
146 # originally returns it. If you use the default HTTP mapping, the
147 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700148 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
149 # contains progress information and common metadata such as create time.
150 # Some services might not provide such metadata. Any method that returns a
151 # long-running operation should document the metadata type, if any.
152 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
153 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700155 # method returns no data on success, such as `Delete`, the response is
156 # `google.protobuf.Empty`. If the original method is standard
157 # `Get`/`Create`/`Update`, the response should be the resource. For other
158 # methods, the response should have the type `XxxResponse`, where `Xxx`
159 # is the original method name. For example, if the original method name
160 # is `TakeSnapshot()`, the inferred response type is
161 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700162 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700163 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700164 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
165 # If `true`, the operation is completed, and either `error` or `response` is
166 # available.
167 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
168 # different programming environments, including REST APIs and RPC APIs. It is
169 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
170 # three pieces of data: error code, error message, and error details.
171 #
172 # You can find out more about this error model and how to work with it in the
173 # [API Design Guide](https://cloud.google.com/apis/design/errors).
174 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
175 # message types for APIs to use.
176 {
177 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
178 },
179 ],
180 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
181 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
182 # user-facing error message should be localized and sent in the
183 # google.rpc.Status.details field, or localized by the client.
184 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
190 <pre>Delete an AccessPolicy by resource
191name. The longrunning Operation will have a successful status once the
192AccessPolicy
193has been removed from long-lasting storage.
194
195Args:
196 name: string, Required. Resource name for the access policy to delete.
197
198Format `accessPolicies/{policy_id}` (required)
199 x__xgafv: string, V1 error format.
200 Allowed values
201 1 - v1 error format
202 2 - v2 error format
203
204Returns:
205 An object of the form:
206
207 { # This resource represents a long-running operation that is the result of a
208 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700209 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
210 # originally returns it. If you use the default HTTP mapping, the
211 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700212 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
213 # contains progress information and common metadata such as create time.
214 # Some services might not provide such metadata. Any method that returns a
215 # long-running operation should document the metadata type, if any.
216 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
217 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700218 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700219 # method returns no data on success, such as `Delete`, the response is
220 # `google.protobuf.Empty`. If the original method is standard
221 # `Get`/`Create`/`Update`, the response should be the resource. For other
222 # methods, the response should have the type `XxxResponse`, where `Xxx`
223 # is the original method name. For example, if the original method name
224 # is `TakeSnapshot()`, the inferred response type is
225 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700226 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700227 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700228 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
229 # If `true`, the operation is completed, and either `error` or `response` is
230 # available.
231 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
232 # different programming environments, including REST APIs and RPC APIs. It is
233 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
234 # three pieces of data: error code, error message, and error details.
235 #
236 # You can find out more about this error model and how to work with it in the
237 # [API Design Guide](https://cloud.google.com/apis/design/errors).
238 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
239 # message types for APIs to use.
240 {
241 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
242 },
243 ],
244 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
245 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
246 # user-facing error message should be localized and sent in the
247 # google.rpc.Status.details field, or localized by the client.
248 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700249 }</pre>
250</div>
251
252<div class="method">
253 <code class="details" id="get">get(name, x__xgafv=None)</code>
254 <pre>Get an AccessPolicy by name.
255
256Args:
257 name: string, Required. Resource name for the access policy to get.
258
259Format `accessPolicies/{policy_id}` (required)
260 x__xgafv: string, V1 error format.
261 Allowed values
262 1 - v1 error format
263 2 - v2 error format
264
265Returns:
266 An object of the form:
267
268 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim65020912020-05-20 12:08:20 -0700269 # attributes to use Google Cloud services) and `ServicePerimeters` (which
270 # define regions of services able to freely pass data within a perimeter). An
271 # access policy is globally visible within an organization, and the
272 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
274 # Hierarchy. Currently immutable once created. Format:
275 # `organizations/{organization_id}`
276 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the
278 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
279 # two Access Polices will be identical if and only if their etags are
280 # identical. Clients should not expect this to be in any specific format.
281 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
282 # `accessPolicies/{policy_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700283 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700284</div>
285
286<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700287 <code class="details" id="list">list(pageToken=None, pageSize=None, parent=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700288 <pre>List all AccessPolicies under a
289container.
290
291Args:
Bu Sun Kim65020912020-05-20 12:08:20 -0700292 pageToken: string, Next page token for the next batch of AccessPolicy instances. Defaults to
293the first page of results.
294 pageSize: integer, Number of AccessPolicy instances to include in the list. Default 100.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700295 parent: string, Required. Resource name for the container to list AccessPolicy instances
296from.
297
298Format:
299`organizations/{org_id}`
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700300 x__xgafv: string, V1 error format.
301 Allowed values
302 1 - v1 error format
303 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700304
305Returns:
306 An object of the form:
307
308 { # A response to `ListAccessPoliciesRequest`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700309 &quot;accessPolicies&quot;: [ # List of the AccessPolicy instances.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700310 { # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim65020912020-05-20 12:08:20 -0700311 # attributes to use Google Cloud services) and `ServicePerimeters` (which
312 # define regions of services able to freely pass data within a perimeter). An
313 # access policy is globally visible within an organization, and the
314 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim65020912020-05-20 12:08:20 -0700315 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
316 # Hierarchy. Currently immutable once created. Format:
317 # `organizations/{organization_id}`
318 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700319 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the
320 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
321 # two Access Polices will be identical if and only if their etags are
322 # identical. Clients should not expect this to be in any specific format.
323 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
324 # `accessPolicies/{policy_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700325 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700326 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700327 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is
328 # empty, no further results remain.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700329 }</pre>
330</div>
331
332<div class="method">
333 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
334 <pre>Retrieves the next page of results.
335
336Args:
337 previous_request: The request for the previous page. (required)
338 previous_response: The response from the request for the previous page. (required)
339
340Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700341 A request object that you can call &#x27;execute()&#x27; on to request the next
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700342 page. Returns None if there are no more items in the collection.
343 </pre>
344</div>
345
346<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700347 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700348 <pre>Update an AccessPolicy. The
349longrunning Operation from this RPC will have a successful status once the
350changes to the AccessPolicy have propagated
351to long-lasting storage. Syntactic and basic semantic errors will be
352returned in `metadata` as a BadRequest proto.
353
354Args:
355 name: string, Output only. Resource name of the `AccessPolicy`. Format:
356`accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700357 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700358 The object takes the form of:
359
360{ # `AccessPolicy` is a container for `AccessLevels` (which define the necessary
Bu Sun Kim65020912020-05-20 12:08:20 -0700361 # attributes to use Google Cloud services) and `ServicePerimeters` (which
362 # define regions of services able to freely pass data within a perimeter). An
363 # access policy is globally visible within an organization, and the
364 # restrictions it specifies apply to all projects within an organization.
Bu Sun Kim65020912020-05-20 12:08:20 -0700365 &quot;parent&quot;: &quot;A String&quot;, # Required. The parent of this `AccessPolicy` in the Cloud Resource
366 # Hierarchy. Currently immutable once created. Format:
367 # `organizations/{organization_id}`
368 &quot;title&quot;: &quot;A String&quot;, # Required. Human readable title. Does not affect behavior.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700369 &quot;etag&quot;: &quot;A String&quot;, # Output only. An opaque identifier for the current version of the
370 # `AccessPolicy`. This will always be a strongly validated etag, meaning that
371 # two Access Polices will be identical if and only if their etags are
372 # identical. Clients should not expect this to be in any specific format.
373 &quot;name&quot;: &quot;A String&quot;, # Output only. Resource name of the `AccessPolicy`. Format:
374 # `accessPolicies/{policy_id}`
Bu Sun Kim65020912020-05-20 12:08:20 -0700375}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700376
377 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
378 x__xgafv: string, V1 error format.
379 Allowed values
380 1 - v1 error format
381 2 - v2 error format
382
383Returns:
384 An object of the form:
385
386 { # This resource represents a long-running operation that is the result of a
387 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700388 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
389 # originally returns it. If you use the default HTTP mapping, the
390 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700391 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
392 # contains progress information and common metadata such as create time.
393 # Some services might not provide such metadata. Any method that returns a
394 # long-running operation should document the metadata type, if any.
395 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
396 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700397 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700398 # method returns no data on success, such as `Delete`, the response is
399 # `google.protobuf.Empty`. If the original method is standard
400 # `Get`/`Create`/`Update`, the response should be the resource. For other
401 # methods, the response should have the type `XxxResponse`, where `Xxx`
402 # is the original method name. For example, if the original method name
403 # is `TakeSnapshot()`, the inferred response type is
404 # `TakeSnapshotResponse`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700405 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700406 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700407 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
408 # If `true`, the operation is completed, and either `error` or `response` is
409 # available.
410 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
411 # different programming environments, including REST APIs and RPC APIs. It is
412 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
413 # three pieces of data: error code, error message, and error details.
414 #
415 # You can find out more about this error model and how to work with it in the
416 # [API Design Guide](https://cloud.google.com/apis/design/errors).
417 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
418 # message types for APIs to use.
419 {
420 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
421 },
422 ],
423 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
424 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
425 # user-facing error message should be localized and sent in the
426 # google.rpc.Status.details field, or localized by the client.
427 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700428 }</pre>
429</div>
430
431</body></html>