Debian Codegraph @

docs/dyn/accessapproval_v1.projects.approvalRequests.html

raw
1 <html><body>
2 <style>
3
4 body, 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
15 body {
16 font-size: 13px;
17 padding: 1em;
18 }
19
20 h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23 }
24
25 h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28 }
29
30 h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34 }
35
36 pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39 }
40
41 pre {
42 margin-top: 0.5em;
43 }
44
45 h1, h2, h3, p {
46 font-family: Arial, sans serif;
47 }
48
49 h1, 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_v1.html">Access Approval API</a> . <a href="accessapproval_v1.projects.html">projects</a> . <a href="accessapproval_v1.projects.approvalRequests.html">approvalRequests</a></h1>
76 <h2>Instance Methods</h2>
77 <p class="toc_element">
78 <code><a href="#approve">approve(name, body=None, x__xgafv=None)</a></code></p>
79 <p class="firstline">Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.</p>
80 <p class="toc_element">
81 <code><a href="#close">close()</a></code></p>
82 <p class="firstline">Close httplib2 connections.</p>
83 <p class="toc_element">
84 <code><a href="#dismiss">dismiss(name, body=None, x__xgafv=None)</a></code></p>
85 <p class="firstline">Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.</p>
86 <p class="toc_element">
87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
88 <p class="firstline">Gets an approval request. Returns NOT_FOUND if the request does not exist.</p>
89 <p class="toc_element">
90 <code><a href="#invalidate">invalidate(name, body=None, x__xgafv=None)</a></code></p>
91 <p class="firstline">Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.</p>
92 <p class="toc_element">
93 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
94 <p class="firstline">Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.</p>
95 <p class="toc_element">
96 <code><a href="#list_next">list_next()</a></code></p>
97 <p class="firstline">Retrieves the next page of results.</p>
98 <h3>Method Details</h3>
99 <div class="method">
100 <code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code>
101 <pre>Approves a request and returns the updated ApprovalRequest. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
102
103 Args:
104 name: string, Name of the approval request to approve. (required)
105 body: object, The request body.
106 The object takes the form of:
107
108 { # Request to approve an ApprovalRequest.
109 &quot;expireTime&quot;: &quot;A String&quot;, # The expiration time of this approval.
110 }
111
112 x__xgafv: string, V1 error format.
113 Allowed values
114 1 - v1 error format
115 2 - v2 error format
116
117 Returns:
118 An object of the form:
119
120 { # A request for the customer to approve access to a resource.
121 &quot;approve&quot;: { # A decision that has been made to approve access to a resource. # Access was approved.
122 &quot;approveTime&quot;: &quot;A String&quot;, # The time at which approval was granted.
123 &quot;autoApproved&quot;: True or False, # True when the request has been auto-approved.
124 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the approval expires.
125 &quot;invalidateTime&quot;: &quot;A String&quot;, # If set, denotes the timestamp at which the approval is invalidated.
126 &quot;policyApproved&quot;: True or False, # True when the request has been approved by the customer&#x27;s defined policy.
127 &quot;signatureInfo&quot;: { # Information about the digital signature of the resource. # The signature for the ApprovalRequest and details on how it was signed.
128 &quot;customerKmsKeyVersion&quot;: &quot;A String&quot;, # The resource name of the customer CryptoKeyVersion used for signing.
129 &quot;googleKeyAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
130 &quot;googlePublicKeyPem&quot;: &quot;A String&quot;, # The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
131 &quot;serializedApprovalRequest&quot;: &quot;A String&quot;, # The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
132 &quot;signature&quot;: &quot;A String&quot;, # The digital signature.
133 },
134 },
135 &quot;dismiss&quot;: { # A decision that has been made to dismiss an approval request. # The request was dismissed.
136 &quot;dismissTime&quot;: &quot;A String&quot;, # The time at which the approval request was dismissed.
137 &quot;implicit&quot;: True or False, # This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
138 },
139 &quot;name&quot;: &quot;A String&quot;, # The resource name of the request. Format is &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot;.
140 &quot;requestTime&quot;: &quot;A String&quot;, # The time at which approval was requested.
141 &quot;requestedAugmentedInfo&quot;: { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
142 &quot;command&quot;: &quot;A String&quot;, # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
143 },
144 &quot;requestedDuration&quot;: &quot;A String&quot;, # The requested access duration.
145 &quot;requestedExpiration&quot;: &quot;A String&quot;, # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
146 &quot;requestedLocations&quot;: { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
147 &quot;principalOfficeCountry&quot;: &quot;A String&quot;, # The &quot;home office&quot; location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
148 &quot;principalPhysicalLocationCountry&quot;: &quot;A String&quot;, # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
149 },
150 &quot;requestedReason&quot;: { # The access reason for which approval is being requested.
151 &quot;detail&quot;: &quot;A String&quot;, # More detail about certain reason types. See comments for each type above.
152 &quot;type&quot;: &quot;A String&quot;, # Type of access reason.
153 },
154 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a &quot;full&quot; resource name (e.g. &quot;//library.googleapis.com/shelves/shelf1/books/book2&quot;) or a &quot;relative&quot; resource name (e.g. &quot;shelves/shelf1/books/book2&quot;) as described in the resource name specification.
155 &quot;requestedResourceProperties&quot;: { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
156 &quot;excludesDescendants&quot;: True or False, # Whether an approval will exclude the descendants of the resource being requested.
157 },
158 }</pre>
159 </div>
160
161 <div class="method">
162 <code class="details" id="close">close()</code>
163 <pre>Close httplib2 connections.</pre>
164 </div>
165
166 <div class="method">
167 <code class="details" id="dismiss">dismiss(name, body=None, x__xgafv=None)</code>
168 <pre>Dismisses a request. Returns the updated ApprovalRequest. NOTE: When a request is dismissed, it is considered ignored. Dismissing a request does not prevent access granted by other Access Approval requests. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state.
169
170 Args:
171 name: string, Name of the ApprovalRequest to dismiss. (required)
172 body: object, The request body.
173 The object takes the form of:
174
175 { # Request to dismiss an approval request.
176 }
177
178 x__xgafv: string, V1 error format.
179 Allowed values
180 1 - v1 error format
181 2 - v2 error format
182
183 Returns:
184 An object of the form:
185
186 { # A request for the customer to approve access to a resource.
187 &quot;approve&quot;: { # A decision that has been made to approve access to a resource. # Access was approved.
188 &quot;approveTime&quot;: &quot;A String&quot;, # The time at which approval was granted.
189 &quot;autoApproved&quot;: True or False, # True when the request has been auto-approved.
190 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the approval expires.
191 &quot;invalidateTime&quot;: &quot;A String&quot;, # If set, denotes the timestamp at which the approval is invalidated.
192 &quot;policyApproved&quot;: True or False, # True when the request has been approved by the customer&#x27;s defined policy.
193 &quot;signatureInfo&quot;: { # Information about the digital signature of the resource. # The signature for the ApprovalRequest and details on how it was signed.
194 &quot;customerKmsKeyVersion&quot;: &quot;A String&quot;, # The resource name of the customer CryptoKeyVersion used for signing.
195 &quot;googleKeyAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
196 &quot;googlePublicKeyPem&quot;: &quot;A String&quot;, # The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
197 &quot;serializedApprovalRequest&quot;: &quot;A String&quot;, # The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
198 &quot;signature&quot;: &quot;A String&quot;, # The digital signature.
199 },
200 },
201 &quot;dismiss&quot;: { # A decision that has been made to dismiss an approval request. # The request was dismissed.
202 &quot;dismissTime&quot;: &quot;A String&quot;, # The time at which the approval request was dismissed.
203 &quot;implicit&quot;: True or False, # This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
204 },
205 &quot;name&quot;: &quot;A String&quot;, # The resource name of the request. Format is &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot;.
206 &quot;requestTime&quot;: &quot;A String&quot;, # The time at which approval was requested.
207 &quot;requestedAugmentedInfo&quot;: { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
208 &quot;command&quot;: &quot;A String&quot;, # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
209 },
210 &quot;requestedDuration&quot;: &quot;A String&quot;, # The requested access duration.
211 &quot;requestedExpiration&quot;: &quot;A String&quot;, # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
212 &quot;requestedLocations&quot;: { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
213 &quot;principalOfficeCountry&quot;: &quot;A String&quot;, # The &quot;home office&quot; location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
214 &quot;principalPhysicalLocationCountry&quot;: &quot;A String&quot;, # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
215 },
216 &quot;requestedReason&quot;: { # The access reason for which approval is being requested.
217 &quot;detail&quot;: &quot;A String&quot;, # More detail about certain reason types. See comments for each type above.
218 &quot;type&quot;: &quot;A String&quot;, # Type of access reason.
219 },
220 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a &quot;full&quot; resource name (e.g. &quot;//library.googleapis.com/shelves/shelf1/books/book2&quot;) or a &quot;relative&quot; resource name (e.g. &quot;shelves/shelf1/books/book2&quot;) as described in the resource name specification.
221 &quot;requestedResourceProperties&quot;: { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
222 &quot;excludesDescendants&quot;: True or False, # Whether an approval will exclude the descendants of the resource being requested.
223 },
224 }</pre>
225 </div>
226
227 <div class="method">
228 <code class="details" id="get">get(name, x__xgafv=None)</code>
229 <pre>Gets an approval request. Returns NOT_FOUND if the request does not exist.
230
231 Args:
232 name: string, The name of the approval request to retrieve. Format: &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot; (required)
233 x__xgafv: string, V1 error format.
234 Allowed values
235 1 - v1 error format
236 2 - v2 error format
237
238 Returns:
239 An object of the form:
240
241 { # A request for the customer to approve access to a resource.
242 &quot;approve&quot;: { # A decision that has been made to approve access to a resource. # Access was approved.
243 &quot;approveTime&quot;: &quot;A String&quot;, # The time at which approval was granted.
244 &quot;autoApproved&quot;: True or False, # True when the request has been auto-approved.
245 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the approval expires.
246 &quot;invalidateTime&quot;: &quot;A String&quot;, # If set, denotes the timestamp at which the approval is invalidated.
247 &quot;policyApproved&quot;: True or False, # True when the request has been approved by the customer&#x27;s defined policy.
248 &quot;signatureInfo&quot;: { # Information about the digital signature of the resource. # The signature for the ApprovalRequest and details on how it was signed.
249 &quot;customerKmsKeyVersion&quot;: &quot;A String&quot;, # The resource name of the customer CryptoKeyVersion used for signing.
250 &quot;googleKeyAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
251 &quot;googlePublicKeyPem&quot;: &quot;A String&quot;, # The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
252 &quot;serializedApprovalRequest&quot;: &quot;A String&quot;, # The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
253 &quot;signature&quot;: &quot;A String&quot;, # The digital signature.
254 },
255 },
256 &quot;dismiss&quot;: { # A decision that has been made to dismiss an approval request. # The request was dismissed.
257 &quot;dismissTime&quot;: &quot;A String&quot;, # The time at which the approval request was dismissed.
258 &quot;implicit&quot;: True or False, # This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
259 },
260 &quot;name&quot;: &quot;A String&quot;, # The resource name of the request. Format is &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot;.
261 &quot;requestTime&quot;: &quot;A String&quot;, # The time at which approval was requested.
262 &quot;requestedAugmentedInfo&quot;: { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
263 &quot;command&quot;: &quot;A String&quot;, # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
264 },
265 &quot;requestedDuration&quot;: &quot;A String&quot;, # The requested access duration.
266 &quot;requestedExpiration&quot;: &quot;A String&quot;, # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
267 &quot;requestedLocations&quot;: { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
268 &quot;principalOfficeCountry&quot;: &quot;A String&quot;, # The &quot;home office&quot; location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
269 &quot;principalPhysicalLocationCountry&quot;: &quot;A String&quot;, # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
270 },
271 &quot;requestedReason&quot;: { # The access reason for which approval is being requested.
272 &quot;detail&quot;: &quot;A String&quot;, # More detail about certain reason types. See comments for each type above.
273 &quot;type&quot;: &quot;A String&quot;, # Type of access reason.
274 },
275 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a &quot;full&quot; resource name (e.g. &quot;//library.googleapis.com/shelves/shelf1/books/book2&quot;) or a &quot;relative&quot; resource name (e.g. &quot;shelves/shelf1/books/book2&quot;) as described in the resource name specification.
276 &quot;requestedResourceProperties&quot;: { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
277 &quot;excludesDescendants&quot;: True or False, # Whether an approval will exclude the descendants of the resource being requested.
278 },
279 }</pre>
280 </div>
281
282 <div class="method">
283 <code class="details" id="invalidate">invalidate(name, body=None, x__xgafv=None)</code>
284 <pre>Invalidates an existing ApprovalRequest. Returns the updated ApprovalRequest. NOTE: This action revokes Google access based on this approval request. If the resource has other active approvals, access will remain granted. Returns FAILED_PRECONDITION if the request exists but is not in an approved state.
285
286 Args:
287 name: string, Name of the ApprovalRequest to invalidate. (required)
288 body: object, The request body.
289 The object takes the form of:
290
291 { # Request to invalidate an existing approval.
292 }
293
294 x__xgafv: string, V1 error format.
295 Allowed values
296 1 - v1 error format
297 2 - v2 error format
298
299 Returns:
300 An object of the form:
301
302 { # A request for the customer to approve access to a resource.
303 &quot;approve&quot;: { # A decision that has been made to approve access to a resource. # Access was approved.
304 &quot;approveTime&quot;: &quot;A String&quot;, # The time at which approval was granted.
305 &quot;autoApproved&quot;: True or False, # True when the request has been auto-approved.
306 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the approval expires.
307 &quot;invalidateTime&quot;: &quot;A String&quot;, # If set, denotes the timestamp at which the approval is invalidated.
308 &quot;policyApproved&quot;: True or False, # True when the request has been approved by the customer&#x27;s defined policy.
309 &quot;signatureInfo&quot;: { # Information about the digital signature of the resource. # The signature for the ApprovalRequest and details on how it was signed.
310 &quot;customerKmsKeyVersion&quot;: &quot;A String&quot;, # The resource name of the customer CryptoKeyVersion used for signing.
311 &quot;googleKeyAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
312 &quot;googlePublicKeyPem&quot;: &quot;A String&quot;, # The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
313 &quot;serializedApprovalRequest&quot;: &quot;A String&quot;, # The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
314 &quot;signature&quot;: &quot;A String&quot;, # The digital signature.
315 },
316 },
317 &quot;dismiss&quot;: { # A decision that has been made to dismiss an approval request. # The request was dismissed.
318 &quot;dismissTime&quot;: &quot;A String&quot;, # The time at which the approval request was dismissed.
319 &quot;implicit&quot;: True or False, # This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
320 },
321 &quot;name&quot;: &quot;A String&quot;, # The resource name of the request. Format is &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot;.
322 &quot;requestTime&quot;: &quot;A String&quot;, # The time at which approval was requested.
323 &quot;requestedAugmentedInfo&quot;: { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
324 &quot;command&quot;: &quot;A String&quot;, # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
325 },
326 &quot;requestedDuration&quot;: &quot;A String&quot;, # The requested access duration.
327 &quot;requestedExpiration&quot;: &quot;A String&quot;, # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
328 &quot;requestedLocations&quot;: { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
329 &quot;principalOfficeCountry&quot;: &quot;A String&quot;, # The &quot;home office&quot; location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
330 &quot;principalPhysicalLocationCountry&quot;: &quot;A String&quot;, # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
331 },
332 &quot;requestedReason&quot;: { # The access reason for which approval is being requested.
333 &quot;detail&quot;: &quot;A String&quot;, # More detail about certain reason types. See comments for each type above.
334 &quot;type&quot;: &quot;A String&quot;, # Type of access reason.
335 },
336 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a &quot;full&quot; resource name (e.g. &quot;//library.googleapis.com/shelves/shelf1/books/book2&quot;) or a &quot;relative&quot; resource name (e.g. &quot;shelves/shelf1/books/book2&quot;) as described in the resource name specification.
337 &quot;requestedResourceProperties&quot;: { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
338 &quot;excludesDescendants&quot;: True or False, # Whether an approval will exclude the descendants of the resource being requested.
339 },
340 }</pre>
341 </div>
342
343 <div class="method">
344 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
345 <pre>Lists approval requests associated with a project, folder, or organization. Approval requests can be filtered by state (pending, active, dismissed). The order is reverse chronological.
346
347 Args:
348 parent: string, The parent resource. This may be &quot;projects/{project}&quot;, &quot;folders/{folder}&quot;, or &quot;organizations/{organization}&quot;. (required)
349 filter: string, A filter on the type of approval requests to retrieve. Must be one of the following values: * [not set]: Requests that are pending or have active approvals. * ALL: All requests. * PENDING: Only pending requests. * ACTIVE: Only active (i.e. currently approved) requests. * DISMISSED: Only requests that have been dismissed, or requests that are not approved and past expiration. * EXPIRED: Only requests that have been approved, and the approval has expired. * HISTORY: Active, dismissed and expired requests.
350 pageSize: integer, Requested page size.
351 pageToken: string, A token identifying the page of results to return.
352 x__xgafv: string, V1 error format.
353 Allowed values
354 1 - v1 error format
355 2 - v2 error format
356
357 Returns:
358 An object of the form:
359
360 { # Response to listing of ApprovalRequest objects.
361 &quot;approvalRequests&quot;: [ # Approval request details.
362 { # A request for the customer to approve access to a resource.
363 &quot;approve&quot;: { # A decision that has been made to approve access to a resource. # Access was approved.
364 &quot;approveTime&quot;: &quot;A String&quot;, # The time at which approval was granted.
365 &quot;autoApproved&quot;: True or False, # True when the request has been auto-approved.
366 &quot;expireTime&quot;: &quot;A String&quot;, # The time at which the approval expires.
367 &quot;invalidateTime&quot;: &quot;A String&quot;, # If set, denotes the timestamp at which the approval is invalidated.
368 &quot;policyApproved&quot;: True or False, # True when the request has been approved by the customer&#x27;s defined policy.
369 &quot;signatureInfo&quot;: { # Information about the digital signature of the resource. # The signature for the ApprovalRequest and details on how it was signed.
370 &quot;customerKmsKeyVersion&quot;: &quot;A String&quot;, # The resource name of the customer CryptoKeyVersion used for signing.
371 &quot;googleKeyAlgorithm&quot;: &quot;A String&quot;, # The hashing algorithm used for signature verification. It will only be present in the case of Google managed keys.
372 &quot;googlePublicKeyPem&quot;: &quot;A String&quot;, # The public key for the Google default signing, encoded in PEM format. The signature was created using a private key which may be verified using this public key.
373 &quot;serializedApprovalRequest&quot;: &quot;A String&quot;, # The ApprovalRequest that is serialized without the SignatureInfo message field. This data is used with the hashing algorithm to generate the digital signature, and it can be used for signature verification.
374 &quot;signature&quot;: &quot;A String&quot;, # The digital signature.
375 },
376 },
377 &quot;dismiss&quot;: { # A decision that has been made to dismiss an approval request. # The request was dismissed.
378 &quot;dismissTime&quot;: &quot;A String&quot;, # The time at which the approval request was dismissed.
379 &quot;implicit&quot;: True or False, # This field will be true if the ApprovalRequest was implicitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time).
380 },
381 &quot;name&quot;: &quot;A String&quot;, # The resource name of the request. Format is &quot;{projects|folders|organizations}/{id}/approvalRequests/{approval_request}&quot;.
382 &quot;requestTime&quot;: &quot;A String&quot;, # The time at which approval was requested.
383 &quot;requestedAugmentedInfo&quot;: { # This field contains the augmented information of the request. Requires augmented administrative access to be enabled. # This field contains the augmented information of the request.
384 &quot;command&quot;: &quot;A String&quot;, # For command-line tools, the full command-line exactly as entered by the actor without adding any additional characters (such as quotation marks).
385 },
386 &quot;requestedDuration&quot;: &quot;A String&quot;, # The requested access duration.
387 &quot;requestedExpiration&quot;: &quot;A String&quot;, # The original requested expiration for the approval. Calculated by adding the requested_duration to the request_time.
388 &quot;requestedLocations&quot;: { # Physical assigned office and physical location of the Google administrator performing the access. # The locations for which approval is being requested.
389 &quot;principalOfficeCountry&quot;: &quot;A String&quot;, # The &quot;home office&quot; location of the Google administrator. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
390 &quot;principalPhysicalLocationCountry&quot;: &quot;A String&quot;, # Physical location of the Google administrator at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as &quot;US&quot;, &quot;DE&quot; or &quot;GB&quot; or a region code. In some limited situations Google systems may refer refer to a region code instead of a country code. Possible Region Codes: * ASI: Asia * EUR: Europe * OCE: Oceania * AFR: Africa * NAM: North America * SAM: South America * ANT: Antarctica * ANY: Any location
391 },
392 &quot;requestedReason&quot;: { # The access reason for which approval is being requested.
393 &quot;detail&quot;: &quot;A String&quot;, # More detail about certain reason types. See comments for each type above.
394 &quot;type&quot;: &quot;A String&quot;, # Type of access reason.
395 },
396 &quot;requestedResourceName&quot;: &quot;A String&quot;, # The resource for which approval is being requested. The format of the resource name is defined at https://cloud.google.com/apis/design/resource_names. The resource name here may either be a &quot;full&quot; resource name (e.g. &quot;//library.googleapis.com/shelves/shelf1/books/book2&quot;) or a &quot;relative&quot; resource name (e.g. &quot;shelves/shelf1/books/book2&quot;) as described in the resource name specification.
397 &quot;requestedResourceProperties&quot;: { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.
398 &quot;excludesDescendants&quot;: True or False, # Whether an approval will exclude the descendants of the resource being requested.
399 },
400 },
401 ],
402 &quot;nextPageToken&quot;: &quot;A String&quot;, # Token to retrieve the next page of results, or empty if there are no more.
403 }</pre>
404 </div>
405
406 <div class="method">
407 <code class="details" id="list_next">list_next()</code>
408 <pre>Retrieves the next page of results.
409
410 Args:
411 previous_request: The request for the previous page. (required)
412 previous_response: The response from the request for the previous page. (required)
413
414 Returns:
415 A request object that you can call &#x27;execute()&#x27; on to request the next
416 page. Returns None if there are no more items in the collection.
417 </pre>
418 </div>
419
420 </body></html>