Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / d976781ea71d0decea37b297b743f81ccc456ecf / . / docs / dyn / iam_v1.projects.serviceAccounts.html
blob: 44e6d67478a9d7320765aa0aa24f80681d47a916 [file] [log] [blame]
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="iam_v1.html">Google Identity and Access Management API</a> . <a href="iam_v1.projects.html">projects</a> . <a href="iam_v1.projects.serviceAccounts.html">serviceAccounts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="iam_v1.projects.serviceAccounts.keys.html">keys()</a></code>
79</p>
80<p class="firstline">Returns the keys Resource.</p>
81
82<p class="toc_element">
83 <code><a href="#create">create(name, body, x__xgafv=None)</a></code></p>
84<p class="firstline">Creates a service account and returns it.</p>
85<p class="toc_element">
86 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
87<p class="firstline">Deletes a service acount.</p>
88<p class="toc_element">
89 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
90<p class="firstline">Gets a ServiceAccount</p>
91<p class="toc_element">
92 <code><a href="#getIamPolicy">getIamPolicy(resource, x__xgafv=None)</a></code></p>
93<p class="firstline">Returns the IAM access control policy for specified IAM resource.</p>
94<p class="toc_element">
95 <code><a href="#list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</a></code></p>
96<p class="firstline">Lists service accounts for a project.</p>
97<p class="toc_element">
98 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
99<p class="firstline">Retrieves the next page of results.</p>
100<p class="toc_element">
101 <code><a href="#setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</a></code></p>
102<p class="firstline">Sets the IAM access control policy for the specified IAM resource.</p>
103<p class="toc_element">
104 <code><a href="#signBlob">signBlob(name, body, x__xgafv=None)</a></code></p>
105<p class="firstline">Signs a blob using a service account.</p>
106<p class="toc_element">
107 <code><a href="#testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</a></code></p>
108<p class="firstline">Tests the specified permissions against the IAM access control policy for the specified IAM resource.</p>
109<p class="toc_element">
110 <code><a href="#update">update(name, body, x__xgafv=None)</a></code></p>
111<p class="firstline">Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.</p>
112<h3>Method Details</h3>
113<div class="method">
114 <code class="details" id="create">create(name, body, x__xgafv=None)</code>
115 <pre>Creates a service account and returns it.
116
117Args:
118 name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
119 body: object, The request body. (required)
120 The object takes the form of:
121
122{ # The service account create request.
123 "serviceAccount": { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. # The ServiceAccount resource to create. Currently, only the following values are user assignable: display_name .
124 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
125 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
126 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
127 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
128 "etag": "A String", # Used to perform a consistent read-modify-write.
129 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
130 "email": "A String", # @OutputOnly Email address of the service account.
131 },
132 "accountId": "A String", # Required. The account id that is used to generate the service account email address and a stable unique id. It is unique within a project, must be 1-63 characters long, and match the regular expression [a-z]([-a-z0-9]*[a-z0-9]) to comply with RFC1035.
133 }
134
135 x__xgafv: string, V1 error format.
136
137Returns:
138 An object of the form:
139
140 { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
141 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
142 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
143 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
144 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
145 "etag": "A String", # Used to perform a consistent read-modify-write.
146 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
147 "email": "A String", # @OutputOnly Email address of the service account.
148 }</pre>
149</div>
150
151<div class="method">
152 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
153 <pre>Deletes a service acount.
154
155Args:
156 name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
157 x__xgafv: string, V1 error format.
158
159Returns:
160 An object of the form:
161
162 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="get">get(name, x__xgafv=None)</code>
168 <pre>Gets a ServiceAccount
169
170Args:
171 name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
172 x__xgafv: string, V1 error format.
173
174Returns:
175 An object of the form:
176
177 { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
178 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
179 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
180 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
181 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
182 "etag": "A String", # Used to perform a consistent read-modify-write.
183 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
184 "email": "A String", # @OutputOnly Email address of the service account.
185 }</pre>
186</div>
187
188<div class="method">
189 <code class="details" id="getIamPolicy">getIamPolicy(resource, x__xgafv=None)</code>
190 <pre>Returns the IAM access control policy for specified IAM resource.
191
192Args:
193 resource: string, REQUIRED: The resource for which the policy is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `getIamPolicy` documentation. (required)
194 x__xgafv: string, V1 error format.
195
196Returns:
197 An object of the form:
198
199 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
200 "rules": [
201 { # A rule to be applied in a Policy.
202 "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
203 "A String",
204 ],
205 "description": "A String", # Human-readable description of the rule.
206 "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
207 "A String",
208 ],
209 "action": "A String", # Required
210 "conditions": [ # Additional restrictions that must be met
211 { # A condition to be met.
212 "iam": "A String", # Trusted attributes supplied by the IAM system.
213 "svc": "A String", # Trusted attributes discharged by the service.
214 "value": "A String", # The object of the condition. Exactly one of these must be set.
215 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
216 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
217 "A String",
218 ],
219 "op": "A String", # An operator to apply the subject with.
220 },
221 ],
222 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
223 { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
224 "counter": { # Options for counters # Counter options.
225 "field": "A String", # The field value to attribute.
226 "metric": "A String", # The metric to update.
227 },
228 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
229 },
230 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
231 },
232 },
233 ],
234 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
235 "A String",
236 ],
237 },
238 ],
239 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
240 { # Associates `members` with a `role`.
241 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
242 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
243 "A String",
244 ],
245 },
246 ],
247 "version": 42, # Version of the `Policy`. The default version is 0.
248 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
249 }</pre>
250</div>
251
252<div class="method">
253 <code class="details" id="list">list(name, pageToken=None, x__xgafv=None, pageSize=None)</code>
254 <pre>Lists service accounts for a project.
255
256Args:
257 name: string, Required. The resource name of the project associated with the service accounts, such as "projects/123" (required)
258 pageToken: string, Optional pagination token returned in an earlier [ListServiceAccountsResponse.next_page_token].
259 x__xgafv: string, V1 error format.
260 pageSize: integer, Optional limit on the number of service accounts to include in the response. Further accounts can subsequently be obtained by including the [ListServiceAccountsResponse.next_page_token] in a subsequent request.
261
262Returns:
263 An object of the form:
264
265 { # The service account list response.
266 "nextPageToken": "A String", # To retrieve the next page of results, set [ListServiceAccountsRequest.page_token] to this value.
267 "accounts": [ # The list of matching service accounts.
268 { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
269 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
270 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
271 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
272 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
273 "etag": "A String", # Used to perform a consistent read-modify-write.
274 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
275 "email": "A String", # @OutputOnly Email address of the service account.
276 },
277 ],
278 }</pre>
279</div>
280
281<div class="method">
282 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
283 <pre>Retrieves the next page of results.
284
285Args:
286 previous_request: The request for the previous page. (required)
287 previous_response: The response from the request for the previous page. (required)
288
289Returns:
290 A request object that you can call 'execute()' on to request the next
291 page. Returns None if there are no more items in the collection.
292 </pre>
293</div>
294
295<div class="method">
296 <code class="details" id="setIamPolicy">setIamPolicy(resource, body, x__xgafv=None)</code>
297 <pre>Sets the IAM access control policy for the specified IAM resource.
298
299Args:
300 resource: string, REQUIRED: The resource for which the policy is being specified. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `setIamPolicy` documentation. (required)
301 body: object, The request body. (required)
302 The object takes the form of:
303
304{ # Request message for `SetIamPolicy` method.
305 "policy": { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam). # REQUIRED: The complete policy to be applied to the `resource`. The size of the policy is limited to a few 10s of KB. An empty policy is a valid policy but certain Cloud Platform services (such as Projects) might reject them.
306 "rules": [
307 { # A rule to be applied in a Policy.
308 "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
309 "A String",
310 ],
311 "description": "A String", # Human-readable description of the rule.
312 "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
313 "A String",
314 ],
315 "action": "A String", # Required
316 "conditions": [ # Additional restrictions that must be met
317 { # A condition to be met.
318 "iam": "A String", # Trusted attributes supplied by the IAM system.
319 "svc": "A String", # Trusted attributes discharged by the service.
320 "value": "A String", # The object of the condition. Exactly one of these must be set.
321 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
322 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
323 "A String",
324 ],
325 "op": "A String", # An operator to apply the subject with.
326 },
327 ],
328 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
329 { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
330 "counter": { # Options for counters # Counter options.
331 "field": "A String", # The field value to attribute.
332 "metric": "A String", # The metric to update.
333 },
334 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
335 },
336 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
337 },
338 },
339 ],
340 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
341 "A String",
342 ],
343 },
344 ],
345 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
346 { # Associates `members` with a `role`.
347 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
348 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
349 "A String",
350 ],
351 },
352 ],
353 "version": 42, # Version of the `Policy`. The default version is 0.
354 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
355 },
356 }
357
358 x__xgafv: string, V1 error format.
359
360Returns:
361 An object of the form:
362
363 { # Defines an Identity and Access Management (IAM) policy. It is used to specify access control policies for Cloud Platform resources. A `Policy` consists of a list of `bindings`. A `Binding` binds a list of `members` to a `role`, where the members can be user accounts, Google groups, Google domains, and service accounts. A `role` is a named list of permissions defined by IAM. **Example** { "bindings": [ { "role": "roles/owner", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-other-app@appspot.gserviceaccount.com"] }, { "role": "roles/viewer", "members": ["user:sean@example.com"] } ] } For a description of IAM and its features, see the [IAM developer's guide](https://cloud.google.com/iam).
364 "rules": [
365 { # A rule to be applied in a Policy.
366 "notIn": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is not in this set of entries. The format for in and not_in entries is the same as for members in a Binding (see google/iam/v1/policy.proto).
367 "A String",
368 ],
369 "description": "A String", # Human-readable description of the rule.
370 "in": [ # The rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in this set of entries.
371 "A String",
372 ],
373 "action": "A String", # Required
374 "conditions": [ # Additional restrictions that must be met
375 { # A condition to be met.
376 "iam": "A String", # Trusted attributes supplied by the IAM system.
377 "svc": "A String", # Trusted attributes discharged by the service.
378 "value": "A String", # The object of the condition. Exactly one of these must be set.
379 "sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.
380 "values": [ # The objects of the condition. This is mutually exclusive with 'value'.
381 "A String",
382 ],
383 "op": "A String", # An operator to apply the subject with.
384 },
385 ],
386 "logConfig": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.
387 { # Specifies what kind of log the caller must write Increment a streamz counter with the specified metric and field names. Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended. Field names correspond to IAM request parameters and field values are their respective values. At present only "iam_principal", corresponding to IAMContext.principal, is supported. Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/backend_debug_access_count {iam_principal=[value of IAMContext.principal]} At this time we do not support: * multiple field names (though this may be supported in the future) * decrementing the counter * incrementing it by anything other than 1
388 "counter": { # Options for counters # Counter options.
389 "field": "A String", # The field value to attribute.
390 "metric": "A String", # The metric to update.
391 },
392 "dataAccess": { # Write a Data Access (Gin) log # Data access options.
393 },
394 "cloudAudit": { # Write a Cloud Audit log # Cloud audit options.
395 },
396 },
397 ],
398 "permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.
399 "A String",
400 ],
401 },
402 ],
403 "bindings": [ # Associates a list of `members` to a `role`. Multiple `bindings` must not be specified for the same `role`. `bindings` with no members will result in an error.
404 { # Associates `members` with a `role`.
405 "role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`. Required
406 "members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values: * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account. * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account. * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@gmail.com` or `joe@example.com`. * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`. * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`. * `domain:{domain}`: A Google Apps domain name that represents all the users of that domain. For example, `google.com` or `example.com`.
407 "A String",
408 ],
409 },
410 ],
411 "version": 42, # Version of the `Policy`. The default version is 0.
412 "etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy. If no `etag` is provided in the call to `setIamPolicy`, then the existing policy is overwritten blindly.
413 }</pre>
414</div>
415
416<div class="method">
417 <code class="details" id="signBlob">signBlob(name, body, x__xgafv=None)</code>
418 <pre>Signs a blob using a service account.
419
420Args:
421 name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account. (required)
422 body: object, The request body. (required)
423 The object takes the form of:
424
425{ # The service account sign blob request.
426 "bytesToSign": "A String", # The bytes to sign
427 }
428
429 x__xgafv: string, V1 error format.
430
431Returns:
432 An object of the form:
433
434 { # The service account sign blob response.
435 "keyId": "A String", # The id of the key used to sign the blob.
436 "signature": "A String", # The signed blob.
437 }</pre>
438</div>
439
440<div class="method">
441 <code class="details" id="testIamPermissions">testIamPermissions(resource, body, x__xgafv=None)</code>
442 <pre>Tests the specified permissions against the IAM access control policy for the specified IAM resource.
443
444Args:
445 resource: string, REQUIRED: The resource for which the policy detail is being requested. `resource` is usually specified as a path, such as `projects/*project*/zones/*zone*/disks/*disk*`. The format for the path specified in this value is resource specific and is specified in the `testIamPermissions` documentation. (required)
446 body: object, The request body. (required)
447 The object takes the form of:
448
449{ # Request message for `TestIamPermissions` method.
450 "permissions": [ # The set of permissions to check for the `resource`. Permissions with wildcards (such as '*' or 'storage.*') are not allowed. For more information see IAM Overview.
451 "A String",
452 ],
453 }
454
455 x__xgafv: string, V1 error format.
456
457Returns:
458 An object of the form:
459
460 { # Response message for `TestIamPermissions` method.
461 "permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is allowed.
462 "A String",
463 ],
464 }</pre>
465</div>
466
467<div class="method">
468 <code class="details" id="update">update(name, body, x__xgafv=None)</code>
469 <pre>Updates a service account. Currently, only the following fields are updatable: 'display_name' . The 'etag' is mandatory.
470
471Args:
472 name: string, The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}". (required)
473 body: object, The request body. (required)
474 The object takes the form of:
475
476{ # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
477 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
478 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
479 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
480 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
481 "etag": "A String", # Used to perform a consistent read-modify-write.
482 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
483 "email": "A String", # @OutputOnly Email address of the service account.
484}
485
486 x__xgafv: string, V1 error format.
487
488Returns:
489 An object of the form:
490
491 { # A service account in the Identity and Access Management API. To create a service account, you specify the project_id and account_id for the account. The account_id is unique within the project, and used to generate the service account email address and a stable unique id. All other methods can identify accounts using the format "projects/{project}/serviceAccounts/{account}". Using '-' as a wildcard for the project, will infer the project from the account. The account value can be the email address or the unique_id of the service account.
492 "oauth2ClientId": "A String", # @OutputOnly. The OAuth2 client id for the service account. This is used in conjunction with the OAuth2 clientconfig API to make three legged OAuth2 (3LO) flows to access the data of Google users.
493 "displayName": "A String", # Optional. A user-specified description of the service account. Must be fewer than 100 UTF-8 bytes.
494 "name": "A String", # The resource name of the service account in the format "projects/{project}/serviceAccounts/{account}". In requests using '-' as a wildcard for the project, will infer the project from the account and the account value can be the email address or the unique_id of the service account. In responses the resource name will always be in the format "projects/{project}/serviceAccounts/{email}".
495 "projectId": "A String", # @OutputOnly The id of the project that owns the service account.
496 "etag": "A String", # Used to perform a consistent read-modify-write.
497 "uniqueId": "A String", # @OutputOnly unique and stable id of the service account.
498 "email": "A String", # @OutputOnly Email address of the service account.
499 }</pre>
500</div>
501
502</body></html>