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_v1.html">Access Approval API</a> . <a href="accessapproval_v1.organizations.html">organizations</a> . <a href="accessapproval_v1.organizations.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: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. 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="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<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> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="approve">approve(name, body=None, x__xgafv=None)</code> 98 <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. 99 100Args: 101 name: string, Name of the approval request to approve. (required) 102 body: object, The request body. 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 "approve": { # A decision that has been made to approve access to a resource. # Access was approved. 119 "approveTime": "A String", # The time at which approval was granted. 120 "expireTime": "A String", # The time at which the approval expires. 121 }, 122 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed. 123 "dismissTime": "A String", # The time at which the approval request was dismissed. 124 "implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time). 125 }, 126 "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". 127 "requestTime": "A String", # The time at which approval was requested. 128 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. 129 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. 130 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 131 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 132 }, 133 "requestedReason": { # The justification for which approval is being requested. 134 "detail": "A String", # More detail about certain reason types. See comments for each type above. 135 "type": "A String", # Type of access justification. 136 }, 137 "requestedResourceName": "A String", # 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 "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. 138 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. 139 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being requested. 140 }, 141}</pre> 142</div> 143 144<div class="method"> 145 <code class="details" id="close">close()</code> 146 <pre>Close httplib2 connections.</pre> 147</div> 148 149<div class="method"> 150 <code class="details" id="dismiss">dismiss(name, body=None, x__xgafv=None)</code> 151 <pre>Dismisses a request. Returns the updated ApprovalRequest. NOTE: This does not deny access to the resource if another request has been made and approved. It is equivalent in effect to ignoring the request altogether. Returns NOT_FOUND if the request does not exist. Returns FAILED_PRECONDITION if the request exists but is not in a pending state. 152 153Args: 154 name: string, Name of the ApprovalRequest to dismiss. (required) 155 body: object, The request body. 156 The object takes the form of: 157 158{ # Request to dismiss an approval request. 159} 160 161 x__xgafv: string, V1 error format. 162 Allowed values 163 1 - v1 error format 164 2 - v2 error format 165 166Returns: 167 An object of the form: 168 169 { # A request for the customer to approve access to a resource. 170 "approve": { # A decision that has been made to approve access to a resource. # Access was approved. 171 "approveTime": "A String", # The time at which approval was granted. 172 "expireTime": "A String", # The time at which the approval expires. 173 }, 174 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed. 175 "dismissTime": "A String", # The time at which the approval request was dismissed. 176 "implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time). 177 }, 178 "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". 179 "requestTime": "A String", # The time at which approval was requested. 180 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. 181 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. 182 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 183 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 184 }, 185 "requestedReason": { # The justification for which approval is being requested. 186 "detail": "A String", # More detail about certain reason types. See comments for each type above. 187 "type": "A String", # Type of access justification. 188 }, 189 "requestedResourceName": "A String", # 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 "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. 190 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. 191 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being requested. 192 }, 193}</pre> 194</div> 195 196<div class="method"> 197 <code class="details" id="get">get(name, x__xgafv=None)</code> 198 <pre>Gets an approval request. Returns NOT_FOUND if the request does not exist. 199 200Args: 201 name: string, The name of the approval request to retrieve. Format: "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}" (required) 202 x__xgafv: string, V1 error format. 203 Allowed values 204 1 - v1 error format 205 2 - v2 error format 206 207Returns: 208 An object of the form: 209 210 { # A request for the customer to approve access to a resource. 211 "approve": { # A decision that has been made to approve access to a resource. # Access was approved. 212 "approveTime": "A String", # The time at which approval was granted. 213 "expireTime": "A String", # The time at which the approval expires. 214 }, 215 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed. 216 "dismissTime": "A String", # The time at which the approval request was dismissed. 217 "implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time). 218 }, 219 "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". 220 "requestTime": "A String", # The time at which approval was requested. 221 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. 222 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. 223 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 224 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 225 }, 226 "requestedReason": { # The justification for which approval is being requested. 227 "detail": "A String", # More detail about certain reason types. See comments for each type above. 228 "type": "A String", # Type of access justification. 229 }, 230 "requestedResourceName": "A String", # 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 "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. 231 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. 232 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being requested. 233 }, 234}</pre> 235</div> 236 237<div class="method"> 238 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 239 <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. 240 241Args: 242 parent: string, The parent resource. This may be "projects/{project}", "folders/{folder}", or "organizations/{organization}". (required) 243 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. 244 pageSize: integer, Requested page size. 245 pageToken: string, A token identifying the page of results to return. 246 x__xgafv: string, V1 error format. 247 Allowed values 248 1 - v1 error format 249 2 - v2 error format 250 251Returns: 252 An object of the form: 253 254 { # Response to listing of ApprovalRequest objects. 255 "approvalRequests": [ # Approval request details. 256 { # A request for the customer to approve access to a resource. 257 "approve": { # A decision that has been made to approve access to a resource. # Access was approved. 258 "approveTime": "A String", # The time at which approval was granted. 259 "expireTime": "A String", # The time at which the approval expires. 260 }, 261 "dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed. 262 "dismissTime": "A String", # The time at which the approval request was dismissed. 263 "implicit": True or False, # This field will be true if the ApprovalRequest was implcitly dismissed due to inaction by the access approval approvers (the request is not acted on by the approvers before the exiration time). 264 }, 265 "name": "A String", # The resource name of the request. Format is "{projects|folders|organizations}/{id}/approvalRequests/{approval_request}". 266 "requestTime": "A String", # The time at which approval was requested. 267 "requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved, access will be granted from the time of approval until the expiration time. 268 "requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested. 269 "principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 "principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" 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 271 }, 272 "requestedReason": { # The justification for which approval is being requested. 273 "detail": "A String", # More detail about certain reason types. See comments for each type above. 274 "type": "A String", # Type of access justification. 275 }, 276 "requestedResourceName": "A String", # 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 "full" resource name (e.g. "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative" resource name (e.g. "shelves/shelf1/books/book2") as described in the resource name specification. 277 "requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name. 278 "excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being requested. 279 }, 280 }, 281 ], 282 "nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more. 283}</pre> 284</div> 285 286<div class="method"> 287 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 288 <pre>Retrieves the next page of results. 289 290Args: 291 previous_request: The request for the previous page. (required) 292 previous_response: The response from the request for the previous page. (required) 293 294Returns: 295 A request object that you can call 'execute()' on to request the next 296 page. Returns None if there are no more items in the collection. 297 </pre> 298</div> 299 300</body></html>