| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -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_v1.html">Access Approval API</a> . <a href="accessapproval_v1.projects.html">projects</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="accessapproval_v1.projects.approvalRequests.html">approvalRequests()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the approvalRequests Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| 83 | <code><a href="#deleteAccessApprovalSettings">deleteAccessApprovalSettings(name, x__xgafv=None)</a></code></p> |
| 84 | <p class="firstline">Deletes the settings associated with a project, folder, or organization.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#getAccessApprovalSettings">getAccessApprovalSettings(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Gets the settings associated with a project, folder, or organization.</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#updateAccessApprovalSettings">updateAccessApprovalSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Updates the settings associated with a project, folder, or organization.</p> |
| 91 | <h3>Method Details</h3> |
| 92 | <div class="method"> |
| 93 | <code class="details" id="deleteAccessApprovalSettings">deleteAccessApprovalSettings(name, x__xgafv=None)</code> |
| 94 | <pre>Deletes the settings associated with a project, folder, or organization. |
| 95 | This will have the effect of disabling Access Approval for the project, |
| 96 | folder, or organization, but only if all ancestors also have Access |
| 97 | Approval disabled. If Access Approval is enabled at a higher level of the |
| 98 | hierarchy, then Access Approval will still be enabled at this level as |
| 99 | the settings are inherited. |
| 100 | |
| 101 | Args: |
| 102 | name: string, Name of the AccessApprovalSettings to delete. (required) |
| 103 | x__xgafv: string, V1 error format. |
| 104 | Allowed values |
| 105 | 1 - v1 error format |
| 106 | 2 - v2 error format |
| 107 | |
| 108 | Returns: |
| 109 | An object of the form: |
| 110 | |
| 111 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 112 | # empty messages in your APIs. A typical example is to use it as the request |
| 113 | # or the response type of an API method. For instance: |
| 114 | # |
| 115 | # service Foo { |
| 116 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 117 | # } |
| 118 | # |
| 119 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 120 | }</pre> |
| 121 | </div> |
| 122 | |
| 123 | <div class="method"> |
| 124 | <code class="details" id="getAccessApprovalSettings">getAccessApprovalSettings(name, x__xgafv=None)</code> |
| 125 | <pre>Gets the settings associated with a project, folder, or organization. |
| 126 | |
| 127 | Args: |
| 128 | name: string, Name of the AccessApprovalSettings to retrieve. (required) |
| 129 | x__xgafv: string, V1 error format. |
| 130 | Allowed values |
| 131 | 1 - v1 error format |
| 132 | 2 - v2 error format |
| 133 | |
| 134 | Returns: |
| 135 | An object of the form: |
| 136 | |
| 137 | { # Settings on a Project/Folder/Organization related to Access Approval. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 138 | "enrolledAncestor": True or False, # Output only. This field is read only (not settable via |
| 139 | # UpdateAccessAccessApprovalSettings method). If the field is true, that |
| 140 | # indicates that at least one service is enrolled for Access Approval in one |
| 141 | # or more ancestors of the Project or Folder (this field will always be |
| 142 | # unset for the organization since organizations do not have ancestors). |
| 143 | "name": "A String", # The resource name of the settings. Format is one of: |
| 144 | # <ol> |
| 145 | # <li>"projects/{project_id}/accessApprovalSettings"</li> |
| 146 | # <li>"folders/{folder_id}/accessApprovalSettings"</li> |
| 147 | # <li>"organizations/{organization_id}/accessApprovalSettings"</li> |
| 148 | # <ol> |
| 149 | "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access |
| 150 | # Approval enrolled. Access requests for the resource given by name against |
| 151 | # any of these services contained here will be required to have explicit |
| 152 | # approval. If name refers to an organization, enrollment can be done for |
| 153 | # individual services. If name refers to a folder or project, enrollment can |
| 154 | # only be done on an all or nothing basis. |
| 155 | # |
| 156 | # If a cloud_product is repeated in this list, the first entry will be |
| 157 | # honored and all following entries will be discarded. A maximum of 10 |
| 158 | # enrolled services will be enforced, to be expanded as the set of supported |
| 159 | # services is expanded. |
| 160 | { # Represents the enrollment of a cloud resource into a specific service. |
| 161 | "enrollmentLevel": "A String", # The enrollment level of the service. |
| 162 | "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are |
| 163 | # listed below (case-sensitive): |
| 164 | # <ol> |
| 165 | # <li>all</li> |
| 166 | # <li>appengine.googleapis.com</li> |
| 167 | # <li>bigquery.googleapis.com</li> |
| 168 | # <li>bigtable.googleapis.com</li> |
| 169 | # <li>cloudkms.googleapis.com</li> |
| 170 | # <li>compute.googleapis.com</li> |
| 171 | # <li>dataflow.googleapis.com</li> |
| 172 | # <li>iam.googleapis.com</li> |
| 173 | # <li>pubsub.googleapis.com</li> |
| 174 | # <li>storage.googleapis.com</li> |
| 175 | # <ol> |
| 176 | }, |
| 177 | ], |
| 178 | "notificationEmails": [ # A list of email addresses to which notifications relating to approval |
| 179 | # requests should be sent. Notifications relating to a resource will be sent |
| 180 | # to all emails in the settings of ancestor resources of that resource. A |
| 181 | # maximum of 50 email addresses are allowed. |
| 182 | "A String", |
| 183 | ], |
| 184 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 185 | </div> |
| 186 | |
| 187 | <div class="method"> |
| 188 | <code class="details" id="updateAccessApprovalSettings">updateAccessApprovalSettings(name, body=None, updateMask=None, x__xgafv=None)</code> |
| 189 | <pre>Updates the settings associated with a project, folder, or organization. |
| 190 | Settings to update are determined by the value of field_mask. |
| 191 | |
| 192 | Args: |
| 193 | name: string, The resource name of the settings. Format is one of: |
| 194 | <ol> |
| 195 | <li>"projects/{project_id}/accessApprovalSettings"</li> |
| 196 | <li>"folders/{folder_id}/accessApprovalSettings"</li> |
| 197 | <li>"organizations/{organization_id}/accessApprovalSettings"</li> |
| 198 | <ol> (required) |
| 199 | body: object, The request body. |
| 200 | The object takes the form of: |
| 201 | |
| 202 | { # Settings on a Project/Folder/Organization related to Access Approval. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 203 | "enrolledAncestor": True or False, # Output only. This field is read only (not settable via |
| 204 | # UpdateAccessAccessApprovalSettings method). If the field is true, that |
| 205 | # indicates that at least one service is enrolled for Access Approval in one |
| 206 | # or more ancestors of the Project or Folder (this field will always be |
| 207 | # unset for the organization since organizations do not have ancestors). |
| 208 | "name": "A String", # The resource name of the settings. Format is one of: |
| 209 | # <ol> |
| 210 | # <li>"projects/{project_id}/accessApprovalSettings"</li> |
| 211 | # <li>"folders/{folder_id}/accessApprovalSettings"</li> |
| 212 | # <li>"organizations/{organization_id}/accessApprovalSettings"</li> |
| 213 | # <ol> |
| 214 | "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access |
| 215 | # Approval enrolled. Access requests for the resource given by name against |
| 216 | # any of these services contained here will be required to have explicit |
| 217 | # approval. If name refers to an organization, enrollment can be done for |
| 218 | # individual services. If name refers to a folder or project, enrollment can |
| 219 | # only be done on an all or nothing basis. |
| 220 | # |
| 221 | # If a cloud_product is repeated in this list, the first entry will be |
| 222 | # honored and all following entries will be discarded. A maximum of 10 |
| 223 | # enrolled services will be enforced, to be expanded as the set of supported |
| 224 | # services is expanded. |
| 225 | { # Represents the enrollment of a cloud resource into a specific service. |
| 226 | "enrollmentLevel": "A String", # The enrollment level of the service. |
| 227 | "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are |
| 228 | # listed below (case-sensitive): |
| 229 | # <ol> |
| 230 | # <li>all</li> |
| 231 | # <li>appengine.googleapis.com</li> |
| 232 | # <li>bigquery.googleapis.com</li> |
| 233 | # <li>bigtable.googleapis.com</li> |
| 234 | # <li>cloudkms.googleapis.com</li> |
| 235 | # <li>compute.googleapis.com</li> |
| 236 | # <li>dataflow.googleapis.com</li> |
| 237 | # <li>iam.googleapis.com</li> |
| 238 | # <li>pubsub.googleapis.com</li> |
| 239 | # <li>storage.googleapis.com</li> |
| 240 | # <ol> |
| 241 | }, |
| 242 | ], |
| 243 | "notificationEmails": [ # A list of email addresses to which notifications relating to approval |
| 244 | # requests should be sent. Notifications relating to a resource will be sent |
| 245 | # to all emails in the settings of ancestor resources of that resource. A |
| 246 | # maximum of 50 email addresses are allowed. |
| 247 | "A String", |
| 248 | ], |
| 249 | } |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 250 | |
| 251 | updateMask: string, The update mask applies to the settings. Only the top level fields of |
| 252 | AccessApprovalSettings (notification_emails & enrolled_services) are |
| 253 | supported. For each field, if it is included, the currently stored value |
| 254 | will be entirely overwritten with the value of the field passed in this |
| 255 | request. |
| 256 | |
| 257 | For the `FieldMask` definition, see |
| 258 | https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask |
| 259 | If this field is left unset, only the notification_emails field will be |
| 260 | updated. |
| 261 | x__xgafv: string, V1 error format. |
| 262 | Allowed values |
| 263 | 1 - v1 error format |
| 264 | 2 - v2 error format |
| 265 | |
| 266 | Returns: |
| 267 | An object of the form: |
| 268 | |
| 269 | { # Settings on a Project/Folder/Organization related to Access Approval. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame] | 270 | "enrolledAncestor": True or False, # Output only. This field is read only (not settable via |
| 271 | # UpdateAccessAccessApprovalSettings method). If the field is true, that |
| 272 | # indicates that at least one service is enrolled for Access Approval in one |
| 273 | # or more ancestors of the Project or Folder (this field will always be |
| 274 | # unset for the organization since organizations do not have ancestors). |
| 275 | "name": "A String", # The resource name of the settings. Format is one of: |
| 276 | # <ol> |
| 277 | # <li>"projects/{project_id}/accessApprovalSettings"</li> |
| 278 | # <li>"folders/{folder_id}/accessApprovalSettings"</li> |
| 279 | # <li>"organizations/{organization_id}/accessApprovalSettings"</li> |
| 280 | # <ol> |
| 281 | "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access |
| 282 | # Approval enrolled. Access requests for the resource given by name against |
| 283 | # any of these services contained here will be required to have explicit |
| 284 | # approval. If name refers to an organization, enrollment can be done for |
| 285 | # individual services. If name refers to a folder or project, enrollment can |
| 286 | # only be done on an all or nothing basis. |
| 287 | # |
| 288 | # If a cloud_product is repeated in this list, the first entry will be |
| 289 | # honored and all following entries will be discarded. A maximum of 10 |
| 290 | # enrolled services will be enforced, to be expanded as the set of supported |
| 291 | # services is expanded. |
| 292 | { # Represents the enrollment of a cloud resource into a specific service. |
| 293 | "enrollmentLevel": "A String", # The enrollment level of the service. |
| 294 | "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are |
| 295 | # listed below (case-sensitive): |
| 296 | # <ol> |
| 297 | # <li>all</li> |
| 298 | # <li>appengine.googleapis.com</li> |
| 299 | # <li>bigquery.googleapis.com</li> |
| 300 | # <li>bigtable.googleapis.com</li> |
| 301 | # <li>cloudkms.googleapis.com</li> |
| 302 | # <li>compute.googleapis.com</li> |
| 303 | # <li>dataflow.googleapis.com</li> |
| 304 | # <li>iam.googleapis.com</li> |
| 305 | # <li>pubsub.googleapis.com</li> |
| 306 | # <li>storage.googleapis.com</li> |
| 307 | # <ol> |
| 308 | }, |
| 309 | ], |
| 310 | "notificationEmails": [ # A list of email addresses to which notifications relating to approval |
| 311 | # requests should be sent. Notifications relating to a resource will be sent |
| 312 | # to all emails in the settings of ancestor resources of that resource. A |
| 313 | # maximum of 50 email addresses are allowed. |
| 314 | "A String", |
| 315 | ], |
| 316 | }</pre> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 317 | </div> |
| 318 | |
| 319 | </body></html> |