Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 3bf2781e29cb828409f3a8a21939323286524569 / . / docs / dyn / accessapproval_v1beta1.projects.approvalRequests.html
blob: bccc89916a2c29e1bb3cd8c63495108703252b59 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<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="accessapproval_v1beta1.html">Access Approval API</a> . <a href="accessapproval_v1beta1.projects.html">projects</a> . <a href="accessapproval_v1beta1.projects.approvalRequests.html">approvalRequests</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#approve">approve(name, body, x__xgafv=None)</a></code></p>
79<p class="firstline">Approves a request and returns the updated ApprovalRequest.</p>
80<p class="toc_element">
81 <code><a href="#dismiss">dismiss(name, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Dismisses a request. Returns the updated ApprovalRequest.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Gets an approval request. Returns NOT_FOUND if the request does not exist.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
88<p class="firstline">Lists approval requests associated with a project, folder, or organization.</p>
89<p class="toc_element">
90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
91<p class="firstline">Retrieves the next page of results.</p>
92<h3>Method Details</h3>
93<div class="method">
94 <code class="details" id="approve">approve(name, body, x__xgafv=None)</code>
95 <pre>Approves a request and returns the updated ApprovalRequest.
96
97Returns NOT_FOUND if the request does not exist. Returns
98FAILED_PRECONDITION if the request exists but is not in a pending state.
99
100Args:
101 name: string, Name of the approval request to approve. (required)
102 body: object, The request body. (required)
103 The object takes the form of:
104
105{ # Request to approve an ApprovalRequest.
106 "expireTime": "A String", # The expiration time of this approval.
107 }
108
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 { # A request for the customer to approve access to a resource.
118 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
119 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
120 # requested.
121 },
122 "requestTime": "A String", # The time at which approval was requested.
123 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,
124 # access will be granted from the time of approval until the expiration time.
125 "name": "A String", # The resource name of the request. Format is
126 # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
127 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
128 "dismissTime": "A String", # The time at which the approval request was dismissed.
129 },
130 "requestedReason": { # The justification for which approval is being requested.
131 "type": "A String", # Type of access justification.
132 "detail": "A String", # More detail about certain reason types. See comments for each type above.
133 },
134 "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the
135 # resource name is defined at
136 # https://cloud.google.com/apis/design/resource_names. The resource name here
137 # may either be a "full" resource name (e.g.
138 # "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"
139 # resource name (e.g. "shelves/shelf1/books/book2") as described in the
140 # resource name specification.
141 "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
142 "expireTime": "A String", # The time at which the approval expires.
143 "approveTime": "A String", # The time at which approval was granted.
144 },
145 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
146 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code
147 # (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some
148 # limited situations Google systems may refer refer to a region code instead
149 # of a country code.
150 # Possible Region Codes:
151 # <ol>
152 # <li>ASI: Asia</li>
153 # <li>EUR: Europe</li>
154 # <li>OCE: Oceania</li>
155 # <li>AFR: Africa</li>
156 # <li>NAM: North America</li>
157 # <li>SAM: South America</li>
158 # <li>ANT: Antarctica</li>
159 # <li>ANY: Any location</li>
160 # </ol>
161 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A
162 # two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
163 # a region code. In some limited situations Google systems may refer refer to
164 # a region code instead of a country code.
165 # Possible Region Codes:
166 # <ol>
167 # <li>ASI: Asia</li>
168 # <li>EUR: Europe</li>
169 # <li>OCE: Oceania</li>
170 # <li>AFR: Africa</li>
171 # <li>NAM: North America</li>
172 # <li>SAM: South America</li>
173 # <li>ANT: Antarctica</li>
174 # <li>ANY: Any location</li>
175 # </ol>
176 },
177 }</pre>
178</div>
179
180<div class="method">
181 <code class="details" id="dismiss">dismiss(name, body=None, x__xgafv=None)</code>
182 <pre>Dismisses a request. Returns the updated ApprovalRequest.
183
184NOTE: This does not deny access to the resource if another request has been
185made and approved. It is equivalent in effect to ignoring the request
186altogether.
187
188Returns NOT_FOUND if the request does not exist.
189
190Returns FAILED_PRECONDITION if the request exists but is not in a pending
191state.
192
193Args:
194 name: string, Name of the ApprovalRequest to dismiss. (required)
195 body: object, The request body.
196 The object takes the form of:
197
198{ # Request to dismiss an approval request.
199 }
200
201 x__xgafv: string, V1 error format.
202 Allowed values
203 1 - v1 error format
204 2 - v2 error format
205
206Returns:
207 An object of the form:
208
209 { # A request for the customer to approve access to a resource.
210 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
211 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
212 # requested.
213 },
214 "requestTime": "A String", # The time at which approval was requested.
215 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,
216 # access will be granted from the time of approval until the expiration time.
217 "name": "A String", # The resource name of the request. Format is
218 # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
219 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
220 "dismissTime": "A String", # The time at which the approval request was dismissed.
221 },
222 "requestedReason": { # The justification for which approval is being requested.
223 "type": "A String", # Type of access justification.
224 "detail": "A String", # More detail about certain reason types. See comments for each type above.
225 },
226 "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the
227 # resource name is defined at
228 # https://cloud.google.com/apis/design/resource_names. The resource name here
229 # may either be a "full" resource name (e.g.
230 # "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"
231 # resource name (e.g. "shelves/shelf1/books/book2") as described in the
232 # resource name specification.
233 "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
234 "expireTime": "A String", # The time at which the approval expires.
235 "approveTime": "A String", # The time at which approval was granted.
236 },
237 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
238 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code
239 # (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some
240 # limited situations Google systems may refer refer to a region code instead
241 # of a country code.
242 # Possible Region Codes:
243 # <ol>
244 # <li>ASI: Asia</li>
245 # <li>EUR: Europe</li>
246 # <li>OCE: Oceania</li>
247 # <li>AFR: Africa</li>
248 # <li>NAM: North America</li>
249 # <li>SAM: South America</li>
250 # <li>ANT: Antarctica</li>
251 # <li>ANY: Any location</li>
252 # </ol>
253 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A
254 # two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
255 # a region code. In some limited situations Google systems may refer refer to
256 # a region code instead of a country code.
257 # Possible Region Codes:
258 # <ol>
259 # <li>ASI: Asia</li>
260 # <li>EUR: Europe</li>
261 # <li>OCE: Oceania</li>
262 # <li>AFR: Africa</li>
263 # <li>NAM: North America</li>
264 # <li>SAM: South America</li>
265 # <li>ANT: Antarctica</li>
266 # <li>ANY: Any location</li>
267 # </ol>
268 },
269 }</pre>
270</div>
271
272<div class="method">
273 <code class="details" id="get">get(name, x__xgafv=None)</code>
274 <pre>Gets an approval request. Returns NOT_FOUND if the request does not exist.
275
276Args:
277 name: string, Name of the approval request to retrieve. (required)
278 x__xgafv: string, V1 error format.
279 Allowed values
280 1 - v1 error format
281 2 - v2 error format
282
283Returns:
284 An object of the form:
285
286 { # A request for the customer to approve access to a resource.
287 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
288 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
289 # requested.
290 },
291 "requestTime": "A String", # The time at which approval was requested.
292 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,
293 # access will be granted from the time of approval until the expiration time.
294 "name": "A String", # The resource name of the request. Format is
295 # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
296 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
297 "dismissTime": "A String", # The time at which the approval request was dismissed.
298 },
299 "requestedReason": { # The justification for which approval is being requested.
300 "type": "A String", # Type of access justification.
301 "detail": "A String", # More detail about certain reason types. See comments for each type above.
302 },
303 "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the
304 # resource name is defined at
305 # https://cloud.google.com/apis/design/resource_names. The resource name here
306 # may either be a "full" resource name (e.g.
307 # "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"
308 # resource name (e.g. "shelves/shelf1/books/book2") as described in the
309 # resource name specification.
310 "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
311 "expireTime": "A String", # The time at which the approval expires.
312 "approveTime": "A String", # The time at which approval was granted.
313 },
314 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
315 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code
316 # (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some
317 # limited situations Google systems may refer refer to a region code instead
318 # of a country code.
319 # Possible Region Codes:
320 # <ol>
321 # <li>ASI: Asia</li>
322 # <li>EUR: Europe</li>
323 # <li>OCE: Oceania</li>
324 # <li>AFR: Africa</li>
325 # <li>NAM: North America</li>
326 # <li>SAM: South America</li>
327 # <li>ANT: Antarctica</li>
328 # <li>ANY: Any location</li>
329 # </ol>
330 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A
331 # two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
332 # a region code. In some limited situations Google systems may refer refer to
333 # a region code instead of a country code.
334 # Possible Region Codes:
335 # <ol>
336 # <li>ASI: Asia</li>
337 # <li>EUR: Europe</li>
338 # <li>OCE: Oceania</li>
339 # <li>AFR: Africa</li>
340 # <li>NAM: North America</li>
341 # <li>SAM: South America</li>
342 # <li>ANT: Antarctica</li>
343 # <li>ANY: Any location</li>
344 # </ol>
345 },
346 }</pre>
347</div>
348
349<div class="method">
350 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
351 <pre>Lists approval requests associated with a project, folder, or organization.
352Approval requests can be filtered by state (pending, active, dismissed).
353The order is reverse chronological.
354
355Args:
356 parent: string, The parent resource. This may be "projects/{project_id}",
357"folders/{folder_id}", or "organizations/{organization_id}". (required)
358 pageSize: integer, Requested page size.
359 pageToken: string, A token identifying the page of results to return.
360 x__xgafv: string, V1 error format.
361 Allowed values
362 1 - v1 error format
363 2 - v2 error format
364 filter: string, A filter on the type of approval requests to retrieve. Must be one of the
365following values:
366<ol>
367 <li>[not set]: Requests that are pending or have active approvals.</li>
368 <li>ALL: All requests.</li>
369 <li>PENDING: Only pending requests.</li>
370 <li>ACTIVE: Only active (i.e. currently approved) requests.</li>
371 <li>DISMISSED: Only dismissed (including expired) requests.</li>
372</ol>
373
374Returns:
375 An object of the form:
376
377 { # Response to listing of ApprovalRequest objects.
378 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more.
379 "approvalRequests": [ # Approval request details.
380 { # A request for the customer to approve access to a resource.
381 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
382 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being
383 # requested.
384 },
385 "requestTime": "A String", # The time at which approval was requested.
386 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,
387 # access will be granted from the time of approval until the expiration time.
388 "name": "A String", # The resource name of the request. Format is
389 # "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".
390 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.
391 "dismissTime": "A String", # The time at which the approval request was dismissed.
392 },
393 "requestedReason": { # The justification for which approval is being requested.
394 "type": "A String", # Type of access justification.
395 "detail": "A String", # More detail about certain reason types. See comments for each type above.
396 },
397 "requestedResourceName": "A String", # The resource for which approval is being requested. The format of the
398 # resource name is defined at
399 # https://cloud.google.com/apis/design/resource_names. The resource name here
400 # may either be a "full" resource name (e.g.
401 # "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"
402 # resource name (e.g. "shelves/shelf1/books/book2") as described in the
403 # resource name specification.
404 "approve": { # A decision that has been made to approve access to a resource. # Access was approved.
405 "expireTime": "A String", # The time at which the approval expires.
406 "approveTime": "A String", # The time at which approval was granted.
407 },
408 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.
409 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code
410 # (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some
411 # limited situations Google systems may refer refer to a region code instead
412 # of a country code.
413 # Possible Region Codes:
414 # <ol>
415 # <li>ASI: Asia</li>
416 # <li>EUR: Europe</li>
417 # <li>OCE: Oceania</li>
418 # <li>AFR: Africa</li>
419 # <li>NAM: North America</li>
420 # <li>SAM: South America</li>
421 # <li>ANT: Antarctica</li>
422 # <li>ANY: Any location</li>
423 # </ol>
424 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A
425 # two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or
426 # a region code. In some limited situations Google systems may refer refer to
427 # a region code instead of a country code.
428 # Possible Region Codes:
429 # <ol>
430 # <li>ASI: Asia</li>
431 # <li>EUR: Europe</li>
432 # <li>OCE: Oceania</li>
433 # <li>AFR: Africa</li>
434 # <li>NAM: North America</li>
435 # <li>SAM: South America</li>
436 # <li>ANT: Antarctica</li>
437 # <li>ANY: Any location</li>
438 # </ol>
439 },
440 },
441 ],
442 }</pre>
443</div>
444
445<div class="method">
446 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
447 <pre>Retrieves the next page of results.
448
449Args:
450 previous_request: The request for the previous page. (required)
451 previous_response: The response from the request for the previous page. (required)
452
453Returns:
454 A request object that you can call 'execute()' on to request the next
455 page. Returns None if there are no more items in the collection.
456 </pre>
457</div>
458
459</body></html>