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