Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / dd49464a6262c0d1f71efcf11f131e2f591fe5f6 / . / docs / dyn / cloudresourcemanager_v1beta1.projects.html
blob: 4c5c0b73780585d6a468e49fe47d3b8205e62e4e [file] [log] [blame]
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[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
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]75<h1><a href="cloudresourcemanager_v1beta1.html">Cloud Resource Manager API</a> . <a href="cloudresourcemanager_v1beta1.projects.html">projects</a></h1>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]76<h2>Instance Methods</h2>
77<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]78 <code><a href="#create">create(body=None, useLegacyStack=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]79<p class="firstline">Creates a Project resource.</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]80<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]81 <code><a href="#delete">delete(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]82<p class="firstline">Marks the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]83<p class="toc_element">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]84 <code><a href="#get">get(projectId, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]85<p class="firstline">Retrieves the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]86<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87 <code><a href="#getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]88<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]89<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]90 <code><a href="#getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]91<p class="firstline">Returns the IAM access control policy for the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]92<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93 <code><a href="#list">list(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
94<p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]99 <code><a href="#setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</a></code></p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]100<p class="firstline">Sets the IAM access control policy for the specified Project. Overwrites</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]101<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]102 <code><a href="#testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]103<p class="firstline">Returns permissions that a caller has on the specified Project.</p>
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]104<p class="toc_element">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]105 <code><a href="#undelete">undelete(projectId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]106<p class="firstline">Restores the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]107<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]108 <code><a href="#update">update(projectId, body=None, x__xgafv=None)</a></code></p>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]109<p class="firstline">Updates the attributes of the Project identified by the specified</p>
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]110<h3>Method Details</h3>
111<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]112 <code class="details" id="create">create(body=None, useLegacyStack=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]113 <pre>Creates a Project resource.
114
115Initially, the Project resource is owned by its creator exclusively.
116The creator can later grant permission to others to read or update the
117Project.
118
119Several APIs are activated automatically for the Project, including
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]120Google Cloud Storage. The parent is identified by a specified
121ResourceId, which must include both an ID and a type, such as
122project, folder, or organization.
123
124This method does not associate the new project with a billing account.
125You can set or update the billing account associated with a project using
126the [`projects.updateBillingInfo`]
127(/billing/reference/rest/v1/projects/updateBillingInfo) method.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]128
129Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]130 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]131 The object takes the form of:
132
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]133{ # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]134 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]135 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]136 "name": "A String", # The optional user-assigned display name of the Project.
137 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]138 # Allowed characters are: lowercase and uppercase letters, numbers,
139 # hyphen, single-quote, double-quote, space, and exclamation point.
140 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]141 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]142 # Read-write.
143 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
144 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]145 # Supported parent types include "organization" and "folder". Once set, the
146 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]147 # `UpdateProject` method; the end user must have the
148 # `resourcemanager.projects.create` permission on the parent.
149 #
150 # Read-write.
151 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]152 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]153 # a Compute Engine instance, a Cloud SQL database, and so on.
154 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]156 "id": "A String", # Required field for the type-specific id. This should correspond to the id
157 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]158 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]159 "projectId": "A String", # The unique, user-assigned ID of the Project.
160 # It must be 6 to 30 lowercase letters, digits, or hyphens.
161 # It must start with a letter.
162 # Trailing hyphens are prohibited.
163 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]164 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]165 # Read-only after creation.
166 "labels": { # The labels associated with this Project.
167 #
168 # Label keys must be between 1 and 63 characters long and must conform
169 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
170 #
171 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]172 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
173 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]174 #
175 # No more than 256 labels can be associated with a given resource.
176 #
177 # Clients should store labels in a representation such as JSON that does not
178 # depend on specific characters being disallowed.
179 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]180 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]181 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]182 "a_key": "A String",
183 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]185 #
186 # Read-only.
187 "lifecycleState": "A String", # The Project lifecycle state.
188 #
189 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]190 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]191 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]192 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]193 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]194}
195
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]196 useLegacyStack: boolean, A now unused experiment opt-out option.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]197 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]198 Allowed values
199 1 - v1 error format
200 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]201
202Returns:
203 An object of the form:
204
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]205 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]206 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]207 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]208 "name": "A String", # The optional user-assigned display name of the Project.
209 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]210 # Allowed characters are: lowercase and uppercase letters, numbers,
211 # hyphen, single-quote, double-quote, space, and exclamation point.
212 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]213 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]214 # Read-write.
215 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
216 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 # Supported parent types include "organization" and "folder". Once set, the
218 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]219 # `UpdateProject` method; the end user must have the
220 # `resourcemanager.projects.create` permission on the parent.
221 #
222 # Read-write.
223 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]224 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]225 # a Compute Engine instance, a Cloud SQL database, and so on.
226 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]227 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]228 "id": "A String", # Required field for the type-specific id. This should correspond to the id
229 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]230 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]231 "projectId": "A String", # The unique, user-assigned ID of the Project.
232 # It must be 6 to 30 lowercase letters, digits, or hyphens.
233 # It must start with a letter.
234 # Trailing hyphens are prohibited.
235 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]236 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]237 # Read-only after creation.
238 "labels": { # The labels associated with this Project.
239 #
240 # Label keys must be between 1 and 63 characters long and must conform
241 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
242 #
243 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]244 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
245 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]246 #
247 # No more than 256 labels can be associated with a given resource.
248 #
249 # Clients should store labels in a representation such as JSON that does not
250 # depend on specific characters being disallowed.
251 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]252 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]253 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]254 "a_key": "A String",
255 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]256 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]257 #
258 # Read-only.
259 "lifecycleState": "A String", # The Project lifecycle state.
260 #
261 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]262 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]263 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]264 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]265 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]266 }</pre>
267</div>
268
269<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]270 <code class="details" id="delete">delete(projectId, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]271 <pre>Marks the Project identified by the specified
272`project_id` (for example, `my-project-123`) for deletion.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]273This method will only affect the Project if it has a lifecycle state of
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]274ACTIVE.
275
276This method changes the Project's lifecycle state from
277ACTIVE
278to DELETE_REQUESTED.
279The deletion starts at an unspecified time, at which point the project is
280no longer accessible.
281
282Until the deletion completes, you can check the lifecycle state
283checked by retrieving the Project with GetProject,
284and the Project remains visible to ListProjects.
285However, you cannot update the project.
286
287After the deletion completes, the Project is not retrievable by
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]288the GetProject
289and ListProjects
290methods.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]291
292The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]293
294Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]295 projectId: string, The Project ID (for example, `foo-bar-123`).
296
297Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]298 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]299 Allowed values
300 1 - v1 error format
301 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]302
303Returns:
304 An object of the form:
305
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]306 { # A generic empty message that you can re-use to avoid defining duplicated
307 # empty messages in your APIs. A typical example is to use it as the request
308 # or the response type of an API method. For instance:
309 #
310 # service Foo {
311 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
312 # }
313 #
314 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]315 }</pre>
316</div>
317
318<div class="method">
Thomas Coffee2f245372017-03-27 10:39:26 -0700[diff] [blame]319 <code class="details" id="get">get(projectId, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]320 <pre>Retrieves the Project identified by the specified
321`project_id` (for example, `my-project-123`).
322
323The caller must have read permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]324
325Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]326 projectId: string, The Project ID (for example, `my-project-123`).
327
328Required. (required)
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]329 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]330 Allowed values
331 1 - v1 error format
332 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]333
334Returns:
335 An object of the form:
336
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]337 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]338 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]339 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]340 "name": "A String", # The optional user-assigned display name of the Project.
341 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]342 # Allowed characters are: lowercase and uppercase letters, numbers,
343 # hyphen, single-quote, double-quote, space, and exclamation point.
344 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]345 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]346 # Read-write.
347 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
348 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]349 # Supported parent types include "organization" and "folder". Once set, the
350 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]351 # `UpdateProject` method; the end user must have the
352 # `resourcemanager.projects.create` permission on the parent.
353 #
354 # Read-write.
355 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]356 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]357 # a Compute Engine instance, a Cloud SQL database, and so on.
358 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]359 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]360 "id": "A String", # Required field for the type-specific id. This should correspond to the id
361 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]362 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]363 "projectId": "A String", # The unique, user-assigned ID of the Project.
364 # It must be 6 to 30 lowercase letters, digits, or hyphens.
365 # It must start with a letter.
366 # Trailing hyphens are prohibited.
367 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]368 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]369 # Read-only after creation.
370 "labels": { # The labels associated with this Project.
371 #
372 # Label keys must be between 1 and 63 characters long and must conform
373 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
374 #
375 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]376 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
377 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]378 #
379 # No more than 256 labels can be associated with a given resource.
380 #
381 # Clients should store labels in a representation such as JSON that does not
382 # depend on specific characters being disallowed.
383 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]384 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]385 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]386 "a_key": "A String",
387 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]388 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]389 #
390 # Read-only.
391 "lifecycleState": "A String", # The Project lifecycle state.
392 #
393 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]394 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]395 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]396 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]397 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]398 }</pre>
399</div>
400
401<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]402 <code class="details" id="getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]403 <pre>Gets a list of ancestors in the resource hierarchy for the Project
404identified by the specified `project_id` (for example, `my-project-123`).
405
406The caller must have read permissions for this Project.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]407
408Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]409 projectId: string, The Project ID (for example, `my-project-123`).
410
411Required. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]412 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]413 The object takes the form of:
414
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]415{ # The request sent to the
416 # GetAncestry
417 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]418 }
419
420 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]421 Allowed values
422 1 - v1 error format
423 2 - v2 error format
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]424
425Returns:
426 An object of the form:
427
428 { # Response from the GetAncestry method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]429 "ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The
430 # first ancestor is the project itself, followed by the project's parent,
431 # etc.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]432 { # Identifying information for a single ancestor of a project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]433 "resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.
434 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]435 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]436 # a Compute Engine instance, a Cloud SQL database, and so on.
437 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]438 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]439 "id": "A String", # Required field for the type-specific id. This should correspond to the id
440 # used in the type-specific API's.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]441 },
442 },
443 ],
444 }</pre>
445</div>
446
447<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]448 <code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]449 <pre>Returns the IAM access control policy for the specified Project.
450Permission is denied if the policy or the resource does not exist.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]451
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]452For additional information about resource structure and identification,
453see [Resource Names](/apis/design/resource_names).
454
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]455Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]456 resource: string, REQUIRED: The resource for which the policy is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]457See the operation documentation for the appropriate value for this field. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]458 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]459 The object takes the form of:
460
461{ # Request message for `GetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]462 "options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to
463 # `GetIamPolicy`.
464 "requestedPolicyVersion": 42, # Optional. The policy format version to be returned.
465 #
466 # Valid values are 0, 1, and 3. Requests specifying an invalid value will be
467 # rejected.
468 #
469 # Requests for policies with any conditional bindings must specify version 3.
470 # Policies without any conditional bindings may specify any valid value or
471 # leave the field unset.
472 },
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]473 }
474
475 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]476 Allowed values
477 1 - v1 error format
478 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]479
480Returns:
481 An object of the form:
482
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]483 { # An Identity and Access Management (IAM) policy, which specifies access
484 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]485 #
486 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]487 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
488 # `members` to a single `role`. Members can be user accounts, service accounts,
489 # Google groups, and domains (such as G Suite). A `role` is a named list of
490 # permissions; each `role` can be an IAM predefined role or a user-created
491 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]492 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]493 # Optionally, a `binding` can specify a `condition`, which is a logical
494 # expression that allows access to a resource only if the expression evaluates
495 # to `true`. A condition can add constraints based on attributes of the
496 # request, the resource, or both.
497 #
498 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]499 #
500 # {
501 # "bindings": [
502 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]503 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]504 # "members": [
505 # "user:mike@example.com",
506 # "group:admins@example.com",
507 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]508 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]509 # ]
510 # },
511 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]512 # "role": "roles/resourcemanager.organizationViewer",
513 # "members": ["user:eve@example.com"],
514 # "condition": {
515 # "title": "expirable access",
516 # "description": "Does not grant access after Sep 2020",
517 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
518 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]519 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]520 # ],
521 # "etag": "BwWWja0YfJA=",
522 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]523 # }
524 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]525 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]526 #
527 # bindings:
528 # - members:
529 # - user:mike@example.com
530 # - group:admins@example.com
531 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]532 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
533 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]534 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]535 # - user:eve@example.com
536 # role: roles/resourcemanager.organizationViewer
537 # condition:
538 # title: expirable access
539 # description: Does not grant access after Sep 2020
540 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
541 # - etag: BwWWja0YfJA=
542 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]543 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]544 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]545 # [IAM documentation](https://cloud.google.com/iam/docs/).
546 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
547 # `condition` that determines how and when the `bindings` are applied. Each
548 # of the `bindings` must contain at least one member.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]549 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]550 "role": "A String", # Role that is assigned to `members`.
551 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]552 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553 # NOTE: An unsatisfied condition will not allow user access via current
554 # binding. Different bindings, including their conditions, are examined
555 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]556 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
557 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]558 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]559 # Example (Comparison):
560 #
561 # title: "Summary size limit"
562 # description: "Determines if a summary is less than 100 chars"
563 # expression: "document.summary.size() &lt; 100"
564 #
565 # Example (Equality):
566 #
567 # title: "Requestor is owner"
568 # description: "Determines if requestor is the document owner"
569 # expression: "document.owner == request.auth.claims.email"
570 #
571 # Example (Logic):
572 #
573 # title: "Public documents"
574 # description: "Determine whether the document should be publicly visible"
575 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
576 #
577 # Example (Data Manipulation):
578 #
579 # title: "Notification string"
580 # description: "Create a notification string with a timestamp."
581 # expression: "'New message received at ' + string(document.create_time)"
582 #
583 # The exact variables and functions that may be referenced within an expression
584 # are determined by the service that evaluates it. See the service
585 # documentation for additional information.
586 "location": "A String", # Optional. String indicating the location of the expression for error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]587 # reporting, e.g. a file name and a position in the file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]588 "expression": "A String", # Textual representation of an expression in Common Expression Language
589 # syntax.
590 "description": "A String", # Optional. Description of the expression. This is a longer text which
591 # describes the expression, e.g. when hovered over it in a UI.
592 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]593 # its purpose. This can be used e.g. in UIs which allow to enter the
594 # expression.
595 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]596 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
597 # `members` can have the following values:
598 #
599 # * `allUsers`: A special identifier that represents anyone who is
600 # on the internet; with or without a Google account.
601 #
602 # * `allAuthenticatedUsers`: A special identifier that represents anyone
603 # who is authenticated with a Google account or a service account.
604 #
605 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]606 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]607 #
608 #
609 # * `serviceAccount:{emailid}`: An email address that represents a service
610 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
611 #
612 # * `group:{emailid}`: An email address that represents a Google group.
613 # For example, `admins@example.com`.
614 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]615 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
616 # identifier) representing a user that has been recently deleted. For
617 # example, `alice@example.com?uid=123456789012345678901`. If the user is
618 # recovered, this value reverts to `user:{emailid}` and the recovered user
619 # retains the role in the binding.
620 #
621 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
622 # unique identifier) representing a service account that has been recently
623 # deleted. For example,
624 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
625 # If the service account is undeleted, this value reverts to
626 # `serviceAccount:{emailid}` and the undeleted service account retains the
627 # role in the binding.
628 #
629 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
630 # identifier) representing a Google group that has been recently
631 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
632 # the group is recovered, this value reverts to `group:{emailid}` and the
633 # recovered group retains the role in the binding.
634 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]635 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]636 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]637 # users of that domain. For example, `google.com` or `example.com`.
638 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]639 "A String",
640 ],
641 },
642 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]643 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
644 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]645 # The configuration determines which permission types are logged, and what
646 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]647 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]648 #
649 # If there are AuditConfigs for both `allServices` and a specific service,
650 # the union of the two AuditConfigs is used for that service: the log_types
651 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]652 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]653 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]654 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]655 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]656 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]657 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]658 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]659 # "service": "allServices"
660 # "audit_log_configs": [
661 # {
662 # "log_type": "DATA_READ",
663 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]664 # "user:jose@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]665 # ]
666 # },
667 # {
668 # "log_type": "DATA_WRITE",
669 # },
670 # {
671 # "log_type": "ADMIN_READ",
672 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]673 # ]
674 # },
675 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]676 # "service": "sampleservice.googleapis.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]677 # "audit_log_configs": [
678 # {
679 # "log_type": "DATA_READ",
680 # },
681 # {
682 # "log_type": "DATA_WRITE",
683 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]684 # "user:aliya@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]685 # ]
686 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]687 # ]
688 # }
689 # ]
690 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]691 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]692 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
693 # logging. It also exempts jose@example.com from DATA_READ logging, and
694 # aliya@example.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]695 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]696 { # Provides the configuration for logging a type of permissions.
697 # Example:
698 #
699 # {
700 # "audit_log_configs": [
701 # {
702 # "log_type": "DATA_READ",
703 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]704 # "user:jose@example.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]705 # ]
706 # },
707 # {
708 # "log_type": "DATA_WRITE",
709 # }
710 # ]
711 # }
712 #
713 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]714 # jose@example.com from DATA_READ logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]715 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
716 # permission.
717 # Follows the same format of Binding.members.
718 "A String",
719 ],
720 "logType": "A String", # The log type that this config enables.
721 },
722 ],
723 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]724 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]725 # `allServices` is a special value that covers all services.
726 },
727 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]728 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
729 # prevent simultaneous updates of a policy from overwriting each other.
730 # It is strongly suggested that systems make use of the `etag` in the
731 # read-modify-write cycle to perform policy updates in order to avoid race
732 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
733 # systems are expected to put that etag in the request to `setIamPolicy` to
734 # ensure that their change will be applied to the same version of the policy.
735 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]736 # **Important:** If you use IAM Conditions, you must include the `etag` field
737 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
738 # you to overwrite a version `3` policy with a version `1` policy, and all of
739 # the conditions in the version `3` policy are lost.
740 "version": 42, # Specifies the format of the policy.
741 #
742 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
743 # are rejected.
744 #
745 # Any operation that affects conditional role bindings must specify version
746 # `3`. This requirement applies to the following operations:
747 #
748 # * Getting a policy that includes a conditional role binding
749 # * Adding a conditional role binding to a policy
750 # * Changing a conditional role binding in a policy
751 # * Removing any role binding, with or without a condition, from a policy
752 # that includes conditions
753 #
754 # **Important:** If you use IAM Conditions, you must include the `etag` field
755 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
756 # you to overwrite a version `3` policy with a version `1` policy, and all of
757 # the conditions in the version `3` policy are lost.
758 #
759 # If a policy does not include any conditions, operations on that policy may
760 # specify any valid version or leave the field unset.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]761 }</pre>
762</div>
763
764<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]765 <code class="details" id="list">list(pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
766 <pre>Lists Projects that the caller has the `resourcemanager.projects.get`
767permission on and satisfy the specified filter.
768
769This method returns Projects in an unspecified order.
770This method is eventually consistent with project mutations; this means
771that a newly created project may not appear in the results or recent
772updates to an existing project may not be reflected in the results. To
773retrieve the latest state of a project, use the
774GetProject method.
775
776NOTE: If the request filter contains a `parent.type` and `parent.id` and
777the caller has the `resourcemanager.projects.list` permission on the
778parent, the results will be drawn from an alternate index which provides
779more consistent results. In future versions of this API, this List method
780will be split into List and Search to properly capture the behavorial
781difference.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]782
783Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]784 pageSize: integer, The maximum number of Projects to return in the response.
785The server can return fewer Projects than requested.
786If unspecified, server picks an appropriate default.
787
788Optional.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]789 pageToken: string, A pagination token returned from a previous call to ListProjects
790that indicates from where listing should continue.
791
792Optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]793 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]794 Allowed values
795 1 - v1 error format
796 2 - v2 error format
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]797 filter: string, An expression for filtering the results of the request. Filter rules are
798case insensitive. The fields eligible for filtering are:
799
800+ `name`
801+ `id`
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]802+ `labels.&lt;key&gt;` (where *key* is the name of a label)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]803+ `parent.type`
804+ `parent.id`
805
806Some examples of using labels as filters:
807
808| Filter | Description |
809|------------------|-----------------------------------------------------|
810| name:how* | The project's name starts with "how". |
811| name:Howl | The project's name is `Howl` or `howl`. |
812| name:HOWL | Equivalent to above. |
813| NAME:howl | Equivalent to above. |
814| labels.color:* | The project has the label `color`. |
815| labels.color:red | The project's label `color` has the value `red`. |
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]816| labels.color:red&amp;nbsp;labels.size:big |The project's label `color` has
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]817 the value `red` and its label `size` has the value `big`. |
818
819If no filter is specified, the call will return projects for which the user
820has the `resourcemanager.projects.get` permission.
821
822NOTE: To perform a by-parent query (eg., what projects are directly in a
823Folder), the caller must have the `resourcemanager.projects.list`
824permission on the parent and the filter must contain both a `parent.type`
825and a `parent.id` restriction
826(example: "parent.type:folder parent.id:123"). In this case an alternate
827search index is used which provides more consistent results.
828
829Optional.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]830
831Returns:
832 An object of the form:
833
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]834 { # A page of the response received from the
835 # ListProjects
836 # method.
837 #
838 # A paginated response where more pages are available has
839 # `next_page_token` set. This token can be used in a subsequent request to
840 # retrieve the next request page.
841 "nextPageToken": "A String", # Pagination token.
842 #
843 # If the result set is too large to fit in a single response, this token
844 # is returned. It encodes the position of the current result cursor.
845 # Feeding this value into a new list request with the `page_token` parameter
846 # gives the next page of the results.
847 #
848 # When `next_page_token` is not filled in, there is no next page and
849 # the list returned is the last page in the result set.
850 #
851 # Pagination tokens have a limited lifetime.
852 "projects": [ # The list of Projects that matched the list filter. This list can
853 # be paginated.
854 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]855 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]856 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]857 "name": "A String", # The optional user-assigned display name of the Project.
858 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]859 # Allowed characters are: lowercase and uppercase letters, numbers,
860 # hyphen, single-quote, double-quote, space, and exclamation point.
861 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]862 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]863 # Read-write.
864 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
865 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]866 # Supported parent types include "organization" and "folder". Once set, the
867 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]868 # `UpdateProject` method; the end user must have the
869 # `resourcemanager.projects.create` permission on the parent.
870 #
871 # Read-write.
872 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]873 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]874 # a Compute Engine instance, a Cloud SQL database, and so on.
875 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]876 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]877 "id": "A String", # Required field for the type-specific id. This should correspond to the id
878 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]879 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]880 "projectId": "A String", # The unique, user-assigned ID of the Project.
881 # It must be 6 to 30 lowercase letters, digits, or hyphens.
882 # It must start with a letter.
883 # Trailing hyphens are prohibited.
884 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]885 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]886 # Read-only after creation.
887 "labels": { # The labels associated with this Project.
888 #
889 # Label keys must be between 1 and 63 characters long and must conform
890 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
891 #
892 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]893 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
894 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]895 #
896 # No more than 256 labels can be associated with a given resource.
897 #
898 # Clients should store labels in a representation such as JSON that does not
899 # depend on specific characters being disallowed.
900 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]901 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]902 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]903 "a_key": "A String",
904 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]905 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]906 #
907 # Read-only.
908 "lifecycleState": "A String", # The Project lifecycle state.
909 #
910 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]911 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]912 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]913 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]914 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]915 },
916 ],
917 }</pre>
918</div>
919
920<div class="method">
921 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
922 <pre>Retrieves the next page of results.
923
924Args:
925 previous_request: The request for the previous page. (required)
926 previous_response: The response from the request for the previous page. (required)
927
928Returns:
929 A request object that you can call 'execute()' on to request the next
930 page. Returns None if there are no more items in the collection.
931 </pre>
932</div>
933
934<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]935 <code class="details" id="setIamPolicy">setIamPolicy(resource, body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]936 <pre>Sets the IAM access control policy for the specified Project. Overwrites
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]937any existing policy.
938
939The following constraints apply when using `setIamPolicy()`:
940
941+ Project does not support `allUsers` and `allAuthenticatedUsers` as
942`members` in a `Binding` of a `Policy`.
943
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]944+ The owner role can be granted to a `user`, `serviceAccount`, or a group
945that is part of an organization. For example,
946group@myownpersonaldomain.com could be added as an owner to a project in
947the myownpersonaldomain.com organization, but not the examplepetstore.com
948organization.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]949
950+ Service accounts can be made owners of a project directly
951without any restrictions. However, to be added as an owner, a user must be
952invited via Cloud Platform console and must accept the invitation.
953
954+ A user cannot be granted the owner role using `setIamPolicy()`. The user
955must be granted the owner role using the Cloud Platform Console and must
956explicitly accept the invitation.
957
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]958+ Invitations to grant the owner role cannot be sent using
959`setIamPolicy()`; they must be sent only using the Cloud Platform Console.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]960
961+ Membership changes that leave the project without any owners that have
962accepted the Terms of Service (ToS) will be rejected.
963
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]964+ If the project is not part of an organization, there must be at least
965one owner who has accepted the Terms of Service (ToS) agreement in the
966policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner
967from the policy will fail. This restriction also applies to legacy
968projects that no longer have owners who have accepted the ToS. Edits to
969IAM policies will be rejected until the lack of a ToS-accepting owner is
970rectified.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]971
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]972+ This method will replace the existing policy, and cannot be used to
973append additional IAM settings.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]974
975Note: Removing service accounts from policies or changing their roles
976can render services completely inoperable. It is important to understand
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]977how the service account is being used before removing or updating its
978roles.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]979
980Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]981 resource: string, REQUIRED: The resource for which the policy is being specified.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]982See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]983 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]984 The object takes the form of:
985
986{ # Request message for `SetIamPolicy` method.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]987 "policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]988 # the policy is limited to a few 10s of KB. An empty policy is a
989 # valid policy but certain Cloud Platform services (such as Projects)
990 # might reject them.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]991 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]992 #
993 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]994 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
995 # `members` to a single `role`. Members can be user accounts, service accounts,
996 # Google groups, and domains (such as G Suite). A `role` is a named list of
997 # permissions; each `role` can be an IAM predefined role or a user-created
998 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]999 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1000 # Optionally, a `binding` can specify a `condition`, which is a logical
1001 # expression that allows access to a resource only if the expression evaluates
1002 # to `true`. A condition can add constraints based on attributes of the
1003 # request, the resource, or both.
1004 #
1005 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1006 #
1007 # {
1008 # "bindings": [
1009 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1010 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1011 # "members": [
1012 # "user:mike@example.com",
1013 # "group:admins@example.com",
1014 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1015 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1016 # ]
1017 # },
1018 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1019 # "role": "roles/resourcemanager.organizationViewer",
1020 # "members": ["user:eve@example.com"],
1021 # "condition": {
1022 # "title": "expirable access",
1023 # "description": "Does not grant access after Sep 2020",
1024 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1025 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1026 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1027 # ],
1028 # "etag": "BwWWja0YfJA=",
1029 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1030 # }
1031 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1032 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1033 #
1034 # bindings:
1035 # - members:
1036 # - user:mike@example.com
1037 # - group:admins@example.com
1038 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1039 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1040 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1041 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1042 # - user:eve@example.com
1043 # role: roles/resourcemanager.organizationViewer
1044 # condition:
1045 # title: expirable access
1046 # description: Does not grant access after Sep 2020
1047 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1048 # - etag: BwWWja0YfJA=
1049 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1050 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1051 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1052 # [IAM documentation](https://cloud.google.com/iam/docs/).
1053 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1054 # `condition` that determines how and when the `bindings` are applied. Each
1055 # of the `bindings` must contain at least one member.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1056 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1057 "role": "A String", # Role that is assigned to `members`.
1058 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1059 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1060 # NOTE: An unsatisfied condition will not allow user access via current
1061 # binding. Different bindings, including their conditions, are examined
1062 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1063 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1064 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1065 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1066 # Example (Comparison):
1067 #
1068 # title: "Summary size limit"
1069 # description: "Determines if a summary is less than 100 chars"
1070 # expression: "document.summary.size() &lt; 100"
1071 #
1072 # Example (Equality):
1073 #
1074 # title: "Requestor is owner"
1075 # description: "Determines if requestor is the document owner"
1076 # expression: "document.owner == request.auth.claims.email"
1077 #
1078 # Example (Logic):
1079 #
1080 # title: "Public documents"
1081 # description: "Determine whether the document should be publicly visible"
1082 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1083 #
1084 # Example (Data Manipulation):
1085 #
1086 # title: "Notification string"
1087 # description: "Create a notification string with a timestamp."
1088 # expression: "'New message received at ' + string(document.create_time)"
1089 #
1090 # The exact variables and functions that may be referenced within an expression
1091 # are determined by the service that evaluates it. See the service
1092 # documentation for additional information.
1093 "location": "A String", # Optional. String indicating the location of the expression for error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1094 # reporting, e.g. a file name and a position in the file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1095 "expression": "A String", # Textual representation of an expression in Common Expression Language
1096 # syntax.
1097 "description": "A String", # Optional. Description of the expression. This is a longer text which
1098 # describes the expression, e.g. when hovered over it in a UI.
1099 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1100 # its purpose. This can be used e.g. in UIs which allow to enter the
1101 # expression.
1102 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1103 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1104 # `members` can have the following values:
1105 #
1106 # * `allUsers`: A special identifier that represents anyone who is
1107 # on the internet; with or without a Google account.
1108 #
1109 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1110 # who is authenticated with a Google account or a service account.
1111 #
1112 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1113 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1114 #
1115 #
1116 # * `serviceAccount:{emailid}`: An email address that represents a service
1117 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1118 #
1119 # * `group:{emailid}`: An email address that represents a Google group.
1120 # For example, `admins@example.com`.
1121 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1122 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1123 # identifier) representing a user that has been recently deleted. For
1124 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1125 # recovered, this value reverts to `user:{emailid}` and the recovered user
1126 # retains the role in the binding.
1127 #
1128 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1129 # unique identifier) representing a service account that has been recently
1130 # deleted. For example,
1131 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1132 # If the service account is undeleted, this value reverts to
1133 # `serviceAccount:{emailid}` and the undeleted service account retains the
1134 # role in the binding.
1135 #
1136 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1137 # identifier) representing a Google group that has been recently
1138 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1139 # the group is recovered, this value reverts to `group:{emailid}` and the
1140 # recovered group retains the role in the binding.
1141 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1142 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1143 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1144 # users of that domain. For example, `google.com` or `example.com`.
1145 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1146 "A String",
1147 ],
1148 },
1149 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1150 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1151 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1152 # The configuration determines which permission types are logged, and what
1153 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1154 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1155 #
1156 # If there are AuditConfigs for both `allServices` and a specific service,
1157 # the union of the two AuditConfigs is used for that service: the log_types
1158 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1159 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1160 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1161 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1162 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1163 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1164 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1165 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1166 # "service": "allServices"
1167 # "audit_log_configs": [
1168 # {
1169 # "log_type": "DATA_READ",
1170 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1171 # "user:jose@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1172 # ]
1173 # },
1174 # {
1175 # "log_type": "DATA_WRITE",
1176 # },
1177 # {
1178 # "log_type": "ADMIN_READ",
1179 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1180 # ]
1181 # },
1182 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1183 # "service": "sampleservice.googleapis.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1184 # "audit_log_configs": [
1185 # {
1186 # "log_type": "DATA_READ",
1187 # },
1188 # {
1189 # "log_type": "DATA_WRITE",
1190 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1191 # "user:aliya@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1192 # ]
1193 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1194 # ]
1195 # }
1196 # ]
1197 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1198 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1199 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1200 # logging. It also exempts jose@example.com from DATA_READ logging, and
1201 # aliya@example.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1202 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1203 { # Provides the configuration for logging a type of permissions.
1204 # Example:
1205 #
1206 # {
1207 # "audit_log_configs": [
1208 # {
1209 # "log_type": "DATA_READ",
1210 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1211 # "user:jose@example.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1212 # ]
1213 # },
1214 # {
1215 # "log_type": "DATA_WRITE",
1216 # }
1217 # ]
1218 # }
1219 #
1220 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1221 # jose@example.com from DATA_READ logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1222 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1223 # permission.
1224 # Follows the same format of Binding.members.
1225 "A String",
1226 ],
1227 "logType": "A String", # The log type that this config enables.
1228 },
1229 ],
1230 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1231 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1232 # `allServices` is a special value that covers all services.
1233 },
1234 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1235 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1236 # prevent simultaneous updates of a policy from overwriting each other.
1237 # It is strongly suggested that systems make use of the `etag` in the
1238 # read-modify-write cycle to perform policy updates in order to avoid race
1239 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1240 # systems are expected to put that etag in the request to `setIamPolicy` to
1241 # ensure that their change will be applied to the same version of the policy.
1242 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1243 # **Important:** If you use IAM Conditions, you must include the `etag` field
1244 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1245 # you to overwrite a version `3` policy with a version `1` policy, and all of
1246 # the conditions in the version `3` policy are lost.
1247 "version": 42, # Specifies the format of the policy.
1248 #
1249 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1250 # are rejected.
1251 #
1252 # Any operation that affects conditional role bindings must specify version
1253 # `3`. This requirement applies to the following operations:
1254 #
1255 # * Getting a policy that includes a conditional role binding
1256 # * Adding a conditional role binding to a policy
1257 # * Changing a conditional role binding in a policy
1258 # * Removing any role binding, with or without a condition, from a policy
1259 # that includes conditions
1260 #
1261 # **Important:** If you use IAM Conditions, you must include the `etag` field
1262 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1263 # you to overwrite a version `3` policy with a version `1` policy, and all of
1264 # the conditions in the version `3` policy are lost.
1265 #
1266 # If a policy does not include any conditions, operations on that policy may
1267 # specify any valid version or leave the field unset.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1268 },
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1269 "updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1270 # the fields in the mask will be modified. If no mask is provided, the
1271 # following default mask is used:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1272 #
1273 # `paths: "bindings, etag"`
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1274 }
1275
1276 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1277 Allowed values
1278 1 - v1 error format
1279 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1280
1281Returns:
1282 An object of the form:
1283
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1284 { # An Identity and Access Management (IAM) policy, which specifies access
1285 # controls for Google Cloud resources.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1286 #
1287 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1288 # A `Policy` is a collection of `bindings`. A `binding` binds one or more
1289 # `members` to a single `role`. Members can be user accounts, service accounts,
1290 # Google groups, and domains (such as G Suite). A `role` is a named list of
1291 # permissions; each `role` can be an IAM predefined role or a user-created
1292 # custom role.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1293 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1294 # Optionally, a `binding` can specify a `condition`, which is a logical
1295 # expression that allows access to a resource only if the expression evaluates
1296 # to `true`. A condition can add constraints based on attributes of the
1297 # request, the resource, or both.
1298 #
1299 # **JSON example:**
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1300 #
1301 # {
1302 # "bindings": [
1303 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1304 # "role": "roles/resourcemanager.organizationAdmin",
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1305 # "members": [
1306 # "user:mike@example.com",
1307 # "group:admins@example.com",
1308 # "domain:google.com",
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1309 # "serviceAccount:my-project-id@appspot.gserviceaccount.com"
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1310 # ]
1311 # },
1312 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1313 # "role": "roles/resourcemanager.organizationViewer",
1314 # "members": ["user:eve@example.com"],
1315 # "condition": {
1316 # "title": "expirable access",
1317 # "description": "Does not grant access after Sep 2020",
1318 # "expression": "request.time &lt; timestamp('2020-10-01T00:00:00.000Z')",
1319 # }
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1320 # }
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1321 # ],
1322 # "etag": "BwWWja0YfJA=",
1323 # "version": 3
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1324 # }
1325 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1326 # **YAML example:**
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1327 #
1328 # bindings:
1329 # - members:
1330 # - user:mike@example.com
1331 # - group:admins@example.com
1332 # - domain:google.com
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1333 # - serviceAccount:my-project-id@appspot.gserviceaccount.com
1334 # role: roles/resourcemanager.organizationAdmin
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1335 # - members:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1336 # - user:eve@example.com
1337 # role: roles/resourcemanager.organizationViewer
1338 # condition:
1339 # title: expirable access
1340 # description: Does not grant access after Sep 2020
1341 # expression: request.time &lt; timestamp('2020-10-01T00:00:00.000Z')
1342 # - etag: BwWWja0YfJA=
1343 # - version: 3
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1344 #
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1345 # For a description of IAM and its features, see the
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1346 # [IAM documentation](https://cloud.google.com/iam/docs/).
1347 "bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a
1348 # `condition` that determines how and when the `bindings` are applied. Each
1349 # of the `bindings` must contain at least one member.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1350 { # Associates `members` with a `role`.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1351 "role": "A String", # Role that is assigned to `members`.
1352 # For example, `roles/viewer`, `roles/editor`, or `roles/owner`.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1353 "condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1354 # NOTE: An unsatisfied condition will not allow user access via current
1355 # binding. Different bindings, including their conditions, are examined
1356 # independently.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1357 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
1358 # are documented at https://github.com/google/cel-spec.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1359 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1360 # Example (Comparison):
1361 #
1362 # title: "Summary size limit"
1363 # description: "Determines if a summary is less than 100 chars"
1364 # expression: "document.summary.size() &lt; 100"
1365 #
1366 # Example (Equality):
1367 #
1368 # title: "Requestor is owner"
1369 # description: "Determines if requestor is the document owner"
1370 # expression: "document.owner == request.auth.claims.email"
1371 #
1372 # Example (Logic):
1373 #
1374 # title: "Public documents"
1375 # description: "Determine whether the document should be publicly visible"
1376 # expression: "document.type != 'private' &amp;&amp; document.type != 'internal'"
1377 #
1378 # Example (Data Manipulation):
1379 #
1380 # title: "Notification string"
1381 # description: "Create a notification string with a timestamp."
1382 # expression: "'New message received at ' + string(document.create_time)"
1383 #
1384 # The exact variables and functions that may be referenced within an expression
1385 # are determined by the service that evaluates it. See the service
1386 # documentation for additional information.
1387 "location": "A String", # Optional. String indicating the location of the expression for error
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1388 # reporting, e.g. a file name and a position in the file.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1389 "expression": "A String", # Textual representation of an expression in Common Expression Language
1390 # syntax.
1391 "description": "A String", # Optional. Description of the expression. This is a longer text which
1392 # describes the expression, e.g. when hovered over it in a UI.
1393 "title": "A String", # Optional. Title for the expression, i.e. a short string describing
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1394 # its purpose. This can be used e.g. in UIs which allow to enter the
1395 # expression.
1396 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1397 "members": [ # Specifies the identities requesting access for a Cloud Platform resource.
1398 # `members` can have the following values:
1399 #
1400 # * `allUsers`: A special identifier that represents anyone who is
1401 # on the internet; with or without a Google account.
1402 #
1403 # * `allAuthenticatedUsers`: A special identifier that represents anyone
1404 # who is authenticated with a Google account or a service account.
1405 #
1406 # * `user:{emailid}`: An email address that represents a specific Google
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1407 # account. For example, `alice@example.com` .
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1408 #
1409 #
1410 # * `serviceAccount:{emailid}`: An email address that represents a service
1411 # account. For example, `my-other-app@appspot.gserviceaccount.com`.
1412 #
1413 # * `group:{emailid}`: An email address that represents a Google group.
1414 # For example, `admins@example.com`.
1415 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1416 # * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique
1417 # identifier) representing a user that has been recently deleted. For
1418 # example, `alice@example.com?uid=123456789012345678901`. If the user is
1419 # recovered, this value reverts to `user:{emailid}` and the recovered user
1420 # retains the role in the binding.
1421 #
1422 # * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus
1423 # unique identifier) representing a service account that has been recently
1424 # deleted. For example,
1425 # `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.
1426 # If the service account is undeleted, this value reverts to
1427 # `serviceAccount:{emailid}` and the undeleted service account retains the
1428 # role in the binding.
1429 #
1430 # * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique
1431 # identifier) representing a Google group that has been recently
1432 # deleted. For example, `admins@example.com?uid=123456789012345678901`. If
1433 # the group is recovered, this value reverts to `group:{emailid}` and the
1434 # recovered group retains the role in the binding.
1435 #
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1436 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1437 # * `domain:{domain}`: The G Suite domain (primary) that represents all the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1438 # users of that domain. For example, `google.com` or `example.com`.
1439 #
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1440 "A String",
1441 ],
1442 },
1443 ],
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1444 "auditConfigs": [ # Specifies cloud audit logging configuration for this policy.
1445 { # Specifies the audit configuration for a service.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1446 # The configuration determines which permission types are logged, and what
1447 # identities, if any, are exempted from logging.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1448 # An AuditConfig must have one or more AuditLogConfigs.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1449 #
1450 # If there are AuditConfigs for both `allServices` and a specific service,
1451 # the union of the two AuditConfigs is used for that service: the log_types
1452 # specified in each AuditConfig are enabled, and the exempted_members in each
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1453 # AuditLogConfig are exempted.
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1454 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1455 # Example Policy with multiple AuditConfigs:
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1456 #
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1457 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1458 # "audit_configs": [
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1459 # {
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1460 # "service": "allServices"
1461 # "audit_log_configs": [
1462 # {
1463 # "log_type": "DATA_READ",
1464 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1465 # "user:jose@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1466 # ]
1467 # },
1468 # {
1469 # "log_type": "DATA_WRITE",
1470 # },
1471 # {
1472 # "log_type": "ADMIN_READ",
1473 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1474 # ]
1475 # },
1476 # {
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1477 # "service": "sampleservice.googleapis.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1478 # "audit_log_configs": [
1479 # {
1480 # "log_type": "DATA_READ",
1481 # },
1482 # {
1483 # "log_type": "DATA_WRITE",
1484 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1485 # "user:aliya@example.com"
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1486 # ]
1487 # }
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1488 # ]
1489 # }
1490 # ]
1491 # }
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1492 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1493 # For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ
1494 # logging. It also exempts jose@example.com from DATA_READ logging, and
1495 # aliya@example.com from DATA_WRITE logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1496 "auditLogConfigs": [ # The configuration for logging of each type of permission.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1497 { # Provides the configuration for logging a type of permissions.
1498 # Example:
1499 #
1500 # {
1501 # "audit_log_configs": [
1502 # {
1503 # "log_type": "DATA_READ",
1504 # "exempted_members": [
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1505 # "user:jose@example.com"
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1506 # ]
1507 # },
1508 # {
1509 # "log_type": "DATA_WRITE",
1510 # }
1511 # ]
1512 # }
1513 #
1514 # This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1515 # jose@example.com from DATA_READ logging.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1516 "exemptedMembers": [ # Specifies the identities that do not cause logging for this type of
1517 # permission.
1518 # Follows the same format of Binding.members.
1519 "A String",
1520 ],
1521 "logType": "A String", # The log type that this config enables.
1522 },
1523 ],
1524 "service": "A String", # Specifies a service that will be enabled for audit logging.
Sai Cheemalapatie833b792017-03-24 15:06:46 -0700[diff] [blame]1525 # For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1526 # `allServices` is a special value that covers all services.
1527 },
1528 ],
Sai Cheemalapati4ba8c232017-06-06 18:46:08 -0400[diff] [blame]1529 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help
1530 # prevent simultaneous updates of a policy from overwriting each other.
1531 # It is strongly suggested that systems make use of the `etag` in the
1532 # read-modify-write cycle to perform policy updates in order to avoid race
1533 # conditions: An `etag` is returned in the response to `getIamPolicy`, and
1534 # systems are expected to put that etag in the request to `setIamPolicy` to
1535 # ensure that their change will be applied to the same version of the policy.
1536 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1537 # **Important:** If you use IAM Conditions, you must include the `etag` field
1538 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1539 # you to overwrite a version `3` policy with a version `1` policy, and all of
1540 # the conditions in the version `3` policy are lost.
1541 "version": 42, # Specifies the format of the policy.
1542 #
1543 # Valid values are `0`, `1`, and `3`. Requests that specify an invalid value
1544 # are rejected.
1545 #
1546 # Any operation that affects conditional role bindings must specify version
1547 # `3`. This requirement applies to the following operations:
1548 #
1549 # * Getting a policy that includes a conditional role binding
1550 # * Adding a conditional role binding to a policy
1551 # * Changing a conditional role binding in a policy
1552 # * Removing any role binding, with or without a condition, from a policy
1553 # that includes conditions
1554 #
1555 # **Important:** If you use IAM Conditions, you must include the `etag` field
1556 # whenever you call `setIamPolicy`. If you omit this field, then IAM allows
1557 # you to overwrite a version `3` policy with a version `1` policy, and all of
1558 # the conditions in the version `3` policy are lost.
1559 #
1560 # If a policy does not include any conditions, operations on that policy may
1561 # specify any valid version or leave the field unset.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1562 }</pre>
1563</div>
1564
1565<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1566 <code class="details" id="testIamPermissions">testIamPermissions(resource, body=None, x__xgafv=None)</code>
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1567 <pre>Returns permissions that a caller has on the specified Project.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1568
1569Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1570 resource: string, REQUIRED: The resource for which the policy detail is being requested.
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1571See the operation documentation for the appropriate value for this field. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1572 body: object, The request body.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1573 The object takes the form of:
1574
1575{ # Request message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1576 "permissions": [ # The set of permissions to check for the `resource`. Permissions with
1577 # wildcards (such as '*' or 'storage.*') are not allowed. For more
1578 # information see
1579 # [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1580 "A String",
1581 ],
1582 }
1583
1584 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1585 Allowed values
1586 1 - v1 error format
1587 2 - v2 error format
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1588
1589Returns:
1590 An object of the form:
1591
1592 { # Response message for `TestIamPermissions` method.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1593 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is
1594 # allowed.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1595 "A String",
1596 ],
1597 }</pre>
1598</div>
1599
1600<div class="method">
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1601 <code class="details" id="undelete">undelete(projectId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1602 <pre>Restores the Project identified by the specified
1603`project_id` (for example, `my-project-123`).
1604You can only use this method for a Project that has a lifecycle state of
1605DELETE_REQUESTED.
1606After deletion starts, the Project cannot be restored.
1607
1608The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1609
1610Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1611 projectId: string, The project ID (for example, `foo-bar-123`).
1612
1613Required. (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1614 body: object, The request body.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1615 The object takes the form of:
1616
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1617{ # The request sent to the UndeleteProject
1618 # method.
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]1619 }
1620
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1621 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1622 Allowed values
1623 1 - v1 error format
1624 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1625
1626Returns:
1627 An object of the form:
1628
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1629 { # A generic empty message that you can re-use to avoid defining duplicated
1630 # empty messages in your APIs. A typical example is to use it as the request
1631 # or the response type of an API method. For instance:
1632 #
1633 # service Foo {
1634 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);
1635 # }
1636 #
1637 # The JSON representation for `Empty` is empty JSON object `{}`.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1638 }</pre>
1639</div>
1640
1641<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1642 <code class="details" id="update">update(projectId, body=None, x__xgafv=None)</code>
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1643 <pre>Updates the attributes of the Project identified by the specified
1644`project_id` (for example, `my-project-123`).
1645
1646The caller must have modify permissions for this Project.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1647
1648Args:
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1649 projectId: string, The project ID (for example, `my-project-123`).
1650
1651Required. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1652 body: object, The request body.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1653 The object takes the form of:
1654
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1655{ # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1656 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1657 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1658 "name": "A String", # The optional user-assigned display name of the Project.
1659 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1660 # Allowed characters are: lowercase and uppercase letters, numbers,
1661 # hyphen, single-quote, double-quote, space, and exclamation point.
1662 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1663 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1664 # Read-write.
1665 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1666 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1667 # Supported parent types include "organization" and "folder". Once set, the
1668 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1669 # `UpdateProject` method; the end user must have the
1670 # `resourcemanager.projects.create` permission on the parent.
1671 #
1672 # Read-write.
1673 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1674 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1675 # a Compute Engine instance, a Cloud SQL database, and so on.
1676 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1677 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1678 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1679 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1680 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1681 "projectId": "A String", # The unique, user-assigned ID of the Project.
1682 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1683 # It must start with a letter.
1684 # Trailing hyphens are prohibited.
1685 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1686 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1687 # Read-only after creation.
1688 "labels": { # The labels associated with this Project.
1689 #
1690 # Label keys must be between 1 and 63 characters long and must conform
1691 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1692 #
1693 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1694 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
1695 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1696 #
1697 # No more than 256 labels can be associated with a given resource.
1698 #
1699 # Clients should store labels in a representation such as JSON that does not
1700 # depend on specific characters being disallowed.
1701 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1702 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1703 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1704 "a_key": "A String",
1705 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1706 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1707 #
1708 # Read-only.
1709 "lifecycleState": "A String", # The Project lifecycle state.
1710 #
1711 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1712 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1713 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1714 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1715 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1716}
1717
1718 x__xgafv: string, V1 error format.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1719 Allowed values
1720 1 - v1 error format
1721 2 - v2 error format
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1722
1723Returns:
1724 An object of the form:
1725
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1726 { # A Project is a high-level Google Cloud Platform entity. It is a
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1727 # container for ACLs, APIs, App Engine Apps, VMs, and other
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1728 # Google Cloud Platform resources.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1729 "name": "A String", # The optional user-assigned display name of the Project.
1730 # When present it must be between 4 to 30 characters.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1731 # Allowed characters are: lowercase and uppercase letters, numbers,
1732 # hyphen, single-quote, double-quote, space, and exclamation point.
1733 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1734 # Example: &lt;code&gt;My Project&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1735 # Read-write.
1736 "parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.
1737 #
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1738 # Supported parent types include "organization" and "folder". Once set, the
1739 # parent cannot be cleared. The `parent` can be set on creation or using the
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1740 # `UpdateProject` method; the end user must have the
1741 # `resourcemanager.projects.create` permission on the parent.
1742 #
1743 # Read-write.
1744 # Cloud Platform is a generic term for something you (a developer) may want to
Sai Cheemalapatic30d2b52017-03-13 12:12:03 -0400[diff] [blame]1745 # interact with through one of our API's. Some examples are an App Engine app,
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1746 # a Compute Engine instance, a Cloud SQL database, and so on.
1747 "type": "A String", # Required field representing the resource type this id is for.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1748 # At present, the valid types are "project", "folder", and "organization".
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1749 "id": "A String", # Required field for the type-specific id. This should correspond to the id
1750 # used in the type-specific API's.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]1751 },
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1752 "projectId": "A String", # The unique, user-assigned ID of the Project.
1753 # It must be 6 to 30 lowercase letters, digits, or hyphens.
1754 # It must start with a letter.
1755 # Trailing hyphens are prohibited.
1756 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1757 # Example: &lt;code&gt;tokyo-rain-123&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1758 # Read-only after creation.
1759 "labels": { # The labels associated with this Project.
1760 #
1761 # Label keys must be between 1 and 63 characters long and must conform
1762 # to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.
1763 #
1764 # Label values must be between 0 and 63 characters long and must conform
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1765 # to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label
1766 # value can be empty.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1767 #
1768 # No more than 256 labels can be associated with a given resource.
1769 #
1770 # Clients should store labels in a representation such as JSON that does not
1771 # depend on specific characters being disallowed.
1772 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1773 # Example: &lt;code&gt;"environment" : "dev"&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1774 # Read-write.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1775 "a_key": "A String",
1776 },
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1777 "createTime": "A String", # Creation time.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1778 #
1779 # Read-only.
1780 "lifecycleState": "A String", # The Project lifecycle state.
1781 #
1782 # Read-only.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1783 "projectNumber": "A String", # The number uniquely identifying the project.
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1784 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame^]1785 # Example: &lt;code&gt;415104041262&lt;/code&gt;
Jon Wayne Parrott692617a2017-01-06 09:58:29 -0800[diff] [blame]1786 # Read-only.
Nathaniel Manista4f877e52015-06-15 16:44:50 +0000[diff] [blame]1787 }</pre>
1788</div>
1789
1790</body></html>