Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / accessapproval_v1beta1.projects.html
blob: 25eab1233e897fc650652490d35a1fe1f287b3c8 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="accessapproval_v1beta1.html">Access Approval API</a> . <a href="accessapproval_v1beta1.projects.html">projects</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="accessapproval_v1beta1.projects.approvalRequests.html">approvalRequests()</a></code>
79</p>
80<p class="firstline">Returns the approvalRequests Resource.</p>
81
82<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]89 <code><a href="#updateAccessApprovalSettings">updateAccessApprovalSettings(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90<p class="firstline">Updates the settings associated with a project, folder, or organization.</p>
91<h3>Method Details</h3>
92<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]93 <code class="details" id="deleteAccessApprovalSettings">deleteAccessApprovalSettings(name, x__xgafv=None)</code>
94 <pre>Deletes the settings associated with a project, folder, or organization.
95This will have the effect of disabling Access Approval for the project,
96folder, or organization, but only if all ancestors also have Access
97Approval disabled. If Access Approval is enabled at a higher level of the
98hierarchy, then Access Approval will still be enabled at this level as
99the settings are inherited.
100
101Args:
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
108Returns:
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">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
127Args:
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
134Returns:
135 An object of the form:
136
137 { # Settings on a Project/Folder/Organization related to Access Approval.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 &quot;name&quot;: &quot;A String&quot;, # The resource name of the settings. Format is one of:
139 # &lt;ol&gt;
140 # &lt;li&gt;&quot;projects/{project_id}/accessApprovalSettings&quot;&lt;/li&gt;
141 # &lt;li&gt;&quot;folders/{folder_id}/accessApprovalSettings&quot;&lt;/li&gt;
142 # &lt;li&gt;&quot;organizations/{organization_id}/accessApprovalSettings&quot;&lt;/li&gt;
143 # &lt;ol&gt;
144 &quot;enrolledAncestor&quot;: True or False, # Output only. This field is read only (not settable via
145 # UpdateAccessAccessApprovalSettings method). If the field is true, that
146 # indicates that at least one service is enrolled for Access Approval in one
147 # or more ancestors of the Project or Folder (this field will always be
148 # unset for the organization since organizations do not have ancestors).
149 &quot;enrolledServices&quot;: [ # 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 &quot;cloudProduct&quot;: &quot;A String&quot;, # The product for which Access Approval will be enrolled. Allowed values are
162 # listed below (case-sensitive):
163 # &lt;ol&gt;
164 # &lt;li&gt;all&lt;/li&gt;
165 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
166 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
167 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
168 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
169 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
170 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
171 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
172 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
173 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
174 # &lt;ol&gt;
175 &quot;enrollmentLevel&quot;: &quot;A String&quot;, # The enrollment level of the service.
176 },
177 ],
178 &quot;notificationEmails&quot;: [ # 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 &quot;A String&quot;,
183 ],
184 }</pre>
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.
190Settings to update are determined by the value of field_mask.
191
192Args:
193 name: string, The resource name of the settings. Format is one of:
194&lt;ol&gt;
195 &lt;li&gt;&quot;projects/{project_id}/accessApprovalSettings&quot;&lt;/li&gt;
196 &lt;li&gt;&quot;folders/{folder_id}/accessApprovalSettings&quot;&lt;/li&gt;
197 &lt;li&gt;&quot;organizations/{organization_id}/accessApprovalSettings&quot;&lt;/li&gt;
198&lt;ol&gt; (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.
203 &quot;name&quot;: &quot;A String&quot;, # The resource name of the settings. Format is one of:
204 # &lt;ol&gt;
205 # &lt;li&gt;&quot;projects/{project_id}/accessApprovalSettings&quot;&lt;/li&gt;
206 # &lt;li&gt;&quot;folders/{folder_id}/accessApprovalSettings&quot;&lt;/li&gt;
207 # &lt;li&gt;&quot;organizations/{organization_id}/accessApprovalSettings&quot;&lt;/li&gt;
208 # &lt;ol&gt;
209 &quot;enrolledAncestor&quot;: True or False, # Output only. This field is read only (not settable via
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]210 # UpdateAccessAccessApprovalSettings method). If the field is true, that
211 # indicates that at least one service is enrolled for Access Approval in one
212 # or more ancestors of the Project or Folder (this field will always be
213 # unset for the organization since organizations do not have ancestors).
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;enrolledServices&quot;: [ # A list of Google Cloud Services for which the given resource has Access
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]220 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]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.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]226 &quot;cloudProduct&quot;: &quot;A String&quot;, # The product for which Access Approval will be enrolled. Allowed values are
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]227 # listed below (case-sensitive):
228 # &lt;ol&gt;
229 # &lt;li&gt;all&lt;/li&gt;
230 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
231 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
232 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
233 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
234 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
235 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
236 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
237 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
238 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
239 # &lt;ol&gt;
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]240 &quot;enrollmentLevel&quot;: &quot;A String&quot;, # The enrollment level of the service.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]241 },
242 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]243 &quot;notificationEmails&quot;: [ # 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 &quot;A String&quot;,
248 ],
249 }
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]250
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]251 updateMask: string, For the `FieldMask` definition, see
252https://developers.google.com/protocol-buffers/docs/reference/google.protobuf#fieldmask
253If this field is left unset, only the notification_emails field will be
254updated.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]255 x__xgafv: string, V1 error format.
256 Allowed values
257 1 - v1 error format
258 2 - v2 error format
259
260Returns:
261 An object of the form:
262
263 { # Settings on a Project/Folder/Organization related to Access Approval.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]264 &quot;name&quot;: &quot;A String&quot;, # The resource name of the settings. Format is one of:
265 # &lt;ol&gt;
266 # &lt;li&gt;&quot;projects/{project_id}/accessApprovalSettings&quot;&lt;/li&gt;
267 # &lt;li&gt;&quot;folders/{folder_id}/accessApprovalSettings&quot;&lt;/li&gt;
268 # &lt;li&gt;&quot;organizations/{organization_id}/accessApprovalSettings&quot;&lt;/li&gt;
269 # &lt;ol&gt;
270 &quot;enrolledAncestor&quot;: 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 &quot;enrolledServices&quot;: [ # A list of Google Cloud Services for which the given resource has Access
276 # Approval enrolled. Access requests for the resource given by name against
277 # any of these services contained here will be required to have explicit
278 # approval. If name refers to an organization, enrollment can be done for
279 # individual services. If name refers to a folder or project, enrollment can
280 # only be done on an all or nothing basis.
281 #
282 # If a cloud_product is repeated in this list, the first entry will be
283 # honored and all following entries will be discarded. A maximum of 10
284 # enrolled services will be enforced, to be expanded as the set of supported
285 # services is expanded.
286 { # Represents the enrollment of a cloud resource into a specific service.
287 &quot;cloudProduct&quot;: &quot;A String&quot;, # The product for which Access Approval will be enrolled. Allowed values are
288 # listed below (case-sensitive):
289 # &lt;ol&gt;
290 # &lt;li&gt;all&lt;/li&gt;
291 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
292 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
293 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
294 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
295 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
296 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
297 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
298 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
299 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
300 # &lt;ol&gt;
301 &quot;enrollmentLevel&quot;: &quot;A String&quot;, # The enrollment level of the service.
302 },
303 ],
304 &quot;notificationEmails&quot;: [ # A list of email addresses to which notifications relating to approval
305 # requests should be sent. Notifications relating to a resource will be sent
306 # to all emails in the settings of ancestor resources of that resource. A
307 # maximum of 50 email addresses are allowed.
308 &quot;A String&quot;,
309 ],
310 }</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]311</div>
312
313</body></html>