Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / a527de24cda7c7d62a371203158fd5f617a1c08c / . / docs / dyn / iam_v1.iamPolicies.html
blob: 4746c6319ab79631e7c05b4079d3841c7ef44510 [file] [log] [blame]
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="iam_v1.html">Identity and Access Management (IAM) API</a> . <a href="iam_v1.iamPolicies.html">iamPolicies</a></h1>
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="#lintPolicy">lintPolicy(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]79<p class="firstline">Lints, or validates, an IAM policy. Currently checks the</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</a></code></p>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]82<p class="firstline">Returns a list of services that allow you to opt into audit logs that are</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<h3>Method Details</h3>
84<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]85 <code class="details" id="lintPolicy">lintPolicy(body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]86 <pre>Lints, or validates, an IAM policy. Currently checks the
87google.iam.v1.Binding.condition field, which contains a condition
88expression for a role binding.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]90Successful calls to this method always return an HTTP `200 OK` status code,
91even if the linter detects an issue in the IAM policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92
93Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]94 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95 The object takes the form of:
96
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97{ # The request to lint a Cloud IAM policy object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # google.iam.v1.Binding.condition object to be linted.
99 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
100 # are documented at https://github.com/google/cel-spec.
101 #
102 # Example (Comparison):
103 #
104 # title: &quot;Summary size limit&quot;
105 # description: &quot;Determines if a summary is less than 100 chars&quot;
106 # expression: &quot;document.summary.size() &lt; 100&quot;
107 #
108 # Example (Equality):
109 #
110 # title: &quot;Requestor is owner&quot;
111 # description: &quot;Determines if requestor is the document owner&quot;
112 # expression: &quot;document.owner == request.auth.claims.email&quot;
113 #
114 # Example (Logic):
115 #
116 # title: &quot;Public documents&quot;
117 # description: &quot;Determine whether the document should be publicly visible&quot;
118 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
119 #
120 # Example (Data Manipulation):
121 #
122 # title: &quot;Notification string&quot;
123 # description: &quot;Create a notification string with a timestamp.&quot;
124 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
125 #
126 # The exact variables and functions that may be referenced within an expression
127 # are determined by the service that evaluates it. See the service
128 # documentation for additional information.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]129 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
130 # describes the expression, e.g. when hovered over it in a UI.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]131 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
132 # reporting, e.g. a file name and a position in the file.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]133 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
134 # syntax.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]135 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
136 # its purpose. This can be used e.g. in UIs which allow to enter the
137 # expression.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]138 },
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]139 &quot;fullResourceName&quot;: &quot;A String&quot;, # The full resource name of the policy this lint request is about.
140 #
141 # The name follows the Google Cloud Platform (GCP) resource format.
142 # For example, a GCP project with ID `my-project` will be named
143 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
144 #
145 # The resource name is not used to read the policy instance from the Cloud
146 # IAM database. The candidate policy for lint has to be provided in the same
147 # request object.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]148 }
149
150 x__xgafv: string, V1 error format.
151 Allowed values
152 1 - v1 error format
153 2 - v2 error format
154
155Returns:
156 An object of the form:
157
158 { # The response of a lint operation. An empty response indicates
159 # the operation was able to fully execute and no lint issue was found.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]160 &quot;lintResults&quot;: [ # List of lint results sorted by `severity` in descending order.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]161 { # Structured response of a single validation unit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]162 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field for which this lint result is about.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]163 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]164 # For nested messages `field_name` consists of names of the embedded fields
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]165 # separated by period character. The top-level qualifier is the input object
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]166 # to lint in the request. For example, the `field_name` value
167 # `condition.expression` identifies a lint result for the `expression` field
168 # of the provided condition.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]169 &quot;severity&quot;: &quot;A String&quot;, # The validation unit severity.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]170 &quot;level&quot;: &quot;A String&quot;, # The validation unit level.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700[diff] [blame]171 &quot;validationUnitName&quot;: &quot;A String&quot;, # The validation unit name, for instance
172 # &quot;lintValidationUnits/ConditionComplexityCheck&quot;.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]173 &quot;debugMessage&quot;: &quot;A String&quot;, # Human readable debug message associated with the issue.
174 &quot;locationOffset&quot;: 42, # 0-based character position of problematic construct within the object
175 # identified by `field_name`. Currently, this is populated only for condition
176 # expression.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]177 },
178 ],
179 }</pre>
180</div>
181
182<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]183 <code class="details" id="queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</code>
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700[diff] [blame]184 <pre>Returns a list of services that allow you to opt into audit logs that are
185not generated by default.
186
187To learn more about audit logs, see the [Logging
188documentation](https://cloud.google.com/logging/docs/audit).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]189
190Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]191 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]192 The object takes the form of:
193
194{ # A request to get the list of auditable services for a resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]195 &quot;fullResourceName&quot;: &quot;A String&quot;, # Required. The full resource name to query from the list of auditable
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 # services.
197 #
198 # The name follows the Google Cloud Platform resource format.
199 # For example, a Cloud Platform project with id `my-project` will be named
200 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
201 }
202
203 x__xgafv: string, V1 error format.
204 Allowed values
205 1 - v1 error format
206 2 - v2 error format
207
208Returns:
209 An object of the form:
210
211 { # A response containing a list of auditable services for a resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]212 &quot;services&quot;: [ # The auditable services for a resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]213 { # Contains information about an auditable service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]214 &quot;name&quot;: &quot;A String&quot;, # Public name of the service.
215 # For example, the service name for Cloud IAM is &#x27;iam.googleapis.com&#x27;.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]216 },
217 ],
218 }</pre>
219</div>
220
221</body></html>