Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / b8458c0b73030155b64a3c2392b2f70e5fbc3baf / . / docs / dyn / iam_v1.iamPolicies.html
blob: 1c2515dc5ecf37ed20e669269a4030643d0ec258 [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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]79<p class="firstline">Lints a Cloud IAM policy object or its sub fields. Currently supports</p>
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]82<p class="firstline">Returns a list of services that support service level audit logging</p>
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 Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86 <pre>Lints a Cloud IAM policy object or its sub fields. Currently supports
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]87google.iam.v1.Binding.condition.
88
89Each lint operation consists of multiple lint validation units.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]90Each unit inspects the input object in regard to a particular linting
91aspect and issues a google.iam.admin.v1.LintResult disclosing the
92result.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]93
94The set of applicable validation units is determined by the Cloud IAM
95server and is not configurable.
96
97Regardless of any lint issues or their severities, successful calls to
98`lintPolicy` return an HTTP 200 OK status code.
99
100Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]101 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]102 The object takes the form of:
103
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]104{ # The request to lint a Cloud IAM policy object.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]105 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) # google.iam.v1.Binding.condition object to be linted.
106 # syntax. CEL is a C-like expression language. The syntax and semantics of CEL
107 # are documented at https://github.com/google/cel-spec.
108 #
109 # Example (Comparison):
110 #
111 # title: &quot;Summary size limit&quot;
112 # description: &quot;Determines if a summary is less than 100 chars&quot;
113 # expression: &quot;document.summary.size() &lt; 100&quot;
114 #
115 # Example (Equality):
116 #
117 # title: &quot;Requestor is owner&quot;
118 # description: &quot;Determines if requestor is the document owner&quot;
119 # expression: &quot;document.owner == request.auth.claims.email&quot;
120 #
121 # Example (Logic):
122 #
123 # title: &quot;Public documents&quot;
124 # description: &quot;Determine whether the document should be publicly visible&quot;
125 # expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot;
126 #
127 # Example (Data Manipulation):
128 #
129 # title: &quot;Notification string&quot;
130 # description: &quot;Create a notification string with a timestamp.&quot;
131 # expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot;
132 #
133 # The exact variables and functions that may be referenced within an expression
134 # are determined by the service that evaluates it. See the service
135 # documentation for additional information.
136 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing
137 # its purpose. This can be used e.g. in UIs which allow to enter the
138 # expression.
139 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error
140 # reporting, e.g. a file name and a position in the file.
141 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which
142 # describes the expression, e.g. when hovered over it in a UI.
143 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language
144 # syntax.
145 },
146 &quot;fullResourceName&quot;: &quot;A String&quot;, # The full resource name of the policy this lint request is about.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]147 #
148 # The name follows the Google Cloud Platform (GCP) resource format.
149 # For example, a GCP project with ID `my-project` will be named
150 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
151 #
152 # The resource name is not used to read the policy instance from the Cloud
153 # IAM database. The candidate policy for lint has to be provided in the same
154 # request object.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]155 }
156
157 x__xgafv: string, V1 error format.
158 Allowed values
159 1 - v1 error format
160 2 - v2 error format
161
162Returns:
163 An object of the form:
164
165 { # The response of a lint operation. An empty response indicates
166 # the operation was able to fully execute and no lint issue was found.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 &quot;lintResults&quot;: [ # List of lint results sorted by `severity` in descending order.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]168 { # Structured response of a single validation unit.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]169 &quot;level&quot;: &quot;A String&quot;, # The validation unit level.
170 &quot;severity&quot;: &quot;A String&quot;, # The validation unit severity.
171 &quot;validationUnitName&quot;: &quot;A String&quot;, # The validation unit name, for instance
172 # &quot;lintValidationUnits/ConditionComplexityCheck&quot;.
173 &quot;locationOffset&quot;: 42, # 0-based character position of problematic construct within the object
174 # identified by `field_name`. Currently, this is populated only for condition
175 # expression.
176 &quot;debugMessage&quot;: &quot;A String&quot;, # Human readable debug message associated with the issue.
177 &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]178 #
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]179 # For nested messages `field_name` consists of names of the embedded fields
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]180 # separated by period character. The top-level qualifier is the input object
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]181 # to lint in the request. For example, the `field_name` value
182 # `condition.expression` identifies a lint result for the `expression` field
183 # of the provided condition.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]184 },
185 ],
186 }</pre>
187</div>
188
189<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]190 <code class="details" id="queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</code>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]191 <pre>Returns a list of services that support service level audit logging
192configuration for the given resource.
193
194Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]195 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]196 The object takes the form of:
197
198{ # A request to get the list of auditable services for a resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]199 &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]200 # services.
201 #
202 # The name follows the Google Cloud Platform resource format.
203 # For example, a Cloud Platform project with id `my-project` will be named
204 # `//cloudresourcemanager.googleapis.com/projects/my-project`.
205 }
206
207 x__xgafv: string, V1 error format.
208 Allowed values
209 1 - v1 error format
210 2 - v2 error format
211
212Returns:
213 An object of the form:
214
215 { # A response containing a list of auditable services for a resource.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]216 &quot;services&quot;: [ # The auditable services for a resource.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]217 { # Contains information about an auditable service.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]218 &quot;name&quot;: &quot;A String&quot;, # Public name of the service.
219 # 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]220 },
221 ],
222 }</pre>
223</div>
224
225</body></html>