Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / accessapproval_v1beta1.projects.html
blob: d316e8f1eae6322621ae8963a2217f94a5f94f64 [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.
Dan O'Mearadd494642020-05-01 07:42:23 -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).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143 "notificationEmails": [ # A list of email addresses to which notifications relating to approval
144 # requests should be sent. Notifications relating to a resource will be sent
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]145 # to all emails in the settings of ancestor resources of that resource. A
146 # maximum of 50 email addresses are allowed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 "A String",
148 ],
149 "name": "A String", # The resource name of the settings. Format is one of:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]150 # &lt;ol&gt;
151 # &lt;li&gt;"projects/{project_id}/accessApprovalSettings"&lt;/li&gt;
152 # &lt;li&gt;"folders/{folder_id}/accessApprovalSettings"&lt;/li&gt;
153 # &lt;li&gt;"organizations/{organization_id}/accessApprovalSettings"&lt;/li&gt;
154 # &lt;ol&gt;
155 "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access
156 # Approval enrolled. Access requests for the resource given by name against
157 # any of these services contained here will be required to have explicit
158 # approval. If name refers to an organization, enrollment can be done for
159 # individual services. If name refers to a folder or project, enrollment can
160 # only be done on an all or nothing basis.
161 #
162 # If a cloud_product is repeated in this list, the first entry will be
163 # honored and all following entries will be discarded. A maximum of 10
164 # enrolled services will be enforced, to be expanded as the set of supported
165 # services is expanded.
166 { # Represents the enrollment of a cloud resource into a specific service.
167 "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are
168 # listed below (case-sensitive):
169 # &lt;ol&gt;
170 # &lt;li&gt;all&lt;/li&gt;
171 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
172 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
173 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
174 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
175 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
176 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
177 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
178 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
179 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
180 # &lt;ol&gt;
181 "enrollmentLevel": "A String", # The enrollment level of the service.
182 },
183 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 }</pre>
185</div>
186
187<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]188 <code class="details" id="updateAccessApprovalSettings">updateAccessApprovalSettings(name, body=None, updateMask=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189 <pre>Updates the settings associated with a project, folder, or organization.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]190Settings to update are determined by the value of field_mask.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191
192Args:
193 name: string, The resource name of the settings. Format is one of:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]194&lt;ol&gt;
195 &lt;li&gt;"projects/{project_id}/accessApprovalSettings"&lt;/li&gt;
196 &lt;li&gt;"folders/{folder_id}/accessApprovalSettings"&lt;/li&gt;
197 &lt;li&gt;"organizations/{organization_id}/accessApprovalSettings"&lt;/li&gt;
198&lt;ol&gt; (required)
199 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200 The object takes the form of:
201
202{ # Settings on a Project/Folder/Organization related to Access Approval.
Dan O'Mearadd494642020-05-01 07:42:23 -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).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 "notificationEmails": [ # A list of email addresses to which notifications relating to approval
209 # requests should be sent. Notifications relating to a resource will be sent
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]210 # to all emails in the settings of ancestor resources of that resource. A
211 # maximum of 50 email addresses are allowed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]212 "A String",
213 ],
214 "name": "A String", # The resource name of the settings. Format is one of:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]215 # &lt;ol&gt;
216 # &lt;li&gt;"projects/{project_id}/accessApprovalSettings"&lt;/li&gt;
217 # &lt;li&gt;"folders/{folder_id}/accessApprovalSettings"&lt;/li&gt;
218 # &lt;li&gt;"organizations/{organization_id}/accessApprovalSettings"&lt;/li&gt;
219 # &lt;ol&gt;
220 "enrolledServices": [ # A list of Google Cloud Services for which the given resource has Access
221 # Approval enrolled. Access requests for the resource given by name against
222 # any of these services contained here will be required to have explicit
223 # approval. If name refers to an organization, enrollment can be done for
224 # individual services. If name refers to a folder or project, enrollment can
225 # only be done on an all or nothing basis.
226 #
227 # If a cloud_product is repeated in this list, the first entry will be
228 # honored and all following entries will be discarded. A maximum of 10
229 # enrolled services will be enforced, to be expanded as the set of supported
230 # services is expanded.
231 { # Represents the enrollment of a cloud resource into a specific service.
232 "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are
233 # listed below (case-sensitive):
234 # &lt;ol&gt;
235 # &lt;li&gt;all&lt;/li&gt;
236 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
237 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
238 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
239 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
240 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
241 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
242 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
243 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
244 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
245 # &lt;ol&gt;
246 "enrollmentLevel": "A String", # The enrollment level of the service.
247 },
248 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]249}
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.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 "enrolledAncestor": True or False, # Output only. This field is read only (not settable via
265 # UpdateAccessAccessApprovalSettings method). If the field is true, that
266 # indicates that at least one service is enrolled for Access Approval in one
267 # or more ancestors of the Project or Folder (this field will always be
268 # unset for the organization since organizations do not have ancestors).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]269 "notificationEmails": [ # A list of email addresses to which notifications relating to approval
270 # requests should be sent. Notifications relating to a resource will be sent
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]271 # to all emails in the settings of ancestor resources of that resource. A
272 # maximum of 50 email addresses are allowed.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273 "A String",
274 ],
275 "name": "A String", # The resource name of the settings. Format is one of:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]276 # &lt;ol&gt;
277 # &lt;li&gt;"projects/{project_id}/accessApprovalSettings"&lt;/li&gt;
278 # &lt;li&gt;"folders/{folder_id}/accessApprovalSettings"&lt;/li&gt;
279 # &lt;li&gt;"organizations/{organization_id}/accessApprovalSettings"&lt;/li&gt;
280 # &lt;ol&gt;
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 "cloudProduct": "A String", # The product for which Access Approval will be enrolled. Allowed values are
294 # listed below (case-sensitive):
295 # &lt;ol&gt;
296 # &lt;li&gt;all&lt;/li&gt;
297 # &lt;li&gt;appengine.googleapis.com&lt;/li&gt;
298 # &lt;li&gt;bigquery.googleapis.com&lt;/li&gt;
299 # &lt;li&gt;bigtable.googleapis.com&lt;/li&gt;
300 # &lt;li&gt;cloudkms.googleapis.com&lt;/li&gt;
301 # &lt;li&gt;compute.googleapis.com&lt;/li&gt;
302 # &lt;li&gt;dataflow.googleapis.com&lt;/li&gt;
303 # &lt;li&gt;iam.googleapis.com&lt;/li&gt;
304 # &lt;li&gt;pubsub.googleapis.com&lt;/li&gt;
305 # &lt;li&gt;storage.googleapis.com&lt;/li&gt;
306 # &lt;ol&gt;
307 "enrollmentLevel": "A String", # The enrollment level of the service.
308 },
309 ],
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]310 }</pre>
311</div>
312
313</body></html>