Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e8946f80a759d13a28e71149a08ca8980b6a5a0b / . / docs / dyn / iam_v1.iamPolicies.html
blob: 13182f67eb4e91472abbe76c94db3d96b4160dd0 [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">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]78 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]81 <code><a href="#lintPolicy">lintPolicy(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding.condition field, which contains a condition expression for a role binding. Successful calls to this method always return an HTTP `200 OK` status code, even if the linter detects an issue in the IAM policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]84 <code><a href="#queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Returns a list of services that allow you to opt into audit logs that are not generated by default. To learn more about audit logs, see the [Logging documentation](https://cloud.google.com/logging/docs/audit).</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<h3>Method Details</h3>
87<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88 <code class="details" id="close">close()</code>
89 <pre>Close httplib2 connections.</pre>
90</div>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]91
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]92<div class="method">
93 <code class="details" id="lintPolicy">lintPolicy(body=None, x__xgafv=None)</code>
94 <pre>Lints, or validates, an IAM policy. Currently checks the google.iam.v1.Binding.condition field, which contains a condition expression for a role binding. Successful calls to this method always return an HTTP `200 OK` status code, even if the linter detects an issue in the IAM policy.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]95
96Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]97 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]98 The object takes the form of:
99
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]100{ # The request to lint a Cloud IAM policy object.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]101 &quot;condition&quot;: { # Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: &quot;Summary size limit&quot; description: &quot;Determines if a summary is less than 100 chars&quot; expression: &quot;document.summary.size() &lt; 100&quot; Example (Equality): title: &quot;Requestor is owner&quot; description: &quot;Determines if requestor is the document owner&quot; expression: &quot;document.owner == request.auth.claims.email&quot; Example (Logic): title: &quot;Public documents&quot; description: &quot;Determine whether the document should be publicly visible&quot; expression: &quot;document.type != &#x27;private&#x27; &amp;&amp; document.type != &#x27;internal&#x27;&quot; Example (Data Manipulation): title: &quot;Notification string&quot; description: &quot;Create a notification string with a timestamp.&quot; expression: &quot;&#x27;New message received at &#x27; + string(document.create_time)&quot; The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information. # google.iam.v1.Binding.condition object to be linted.
102 &quot;description&quot;: &quot;A String&quot;, # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI.
103 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
104 &quot;location&quot;: &quot;A String&quot;, # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file.
105 &quot;title&quot;: &quot;A String&quot;, # Optional. Title for the expression, i.e. a short string describing its purpose. This can be used e.g. in UIs which allow to enter the expression.
106 },
107 &quot;fullResourceName&quot;: &quot;A String&quot;, # The full resource name of the policy this lint request is about. The name follows the Google Cloud Platform (GCP) resource format. For example, a GCP project with ID `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`. The resource name is not used to read the policy instance from the Cloud IAM database. The candidate policy for lint has to be provided in the same request object.
108}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]109
110 x__xgafv: string, V1 error format.
111 Allowed values
112 1 - v1 error format
113 2 - v2 error format
114
115Returns:
116 An object of the form:
117
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]118 { # The response of a lint operation. An empty response indicates the operation was able to fully execute and no lint issue was found.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]119 &quot;lintResults&quot;: [ # List of lint results sorted by `severity` in descending order.
120 { # Structured response of a single validation unit.
121 &quot;debugMessage&quot;: &quot;A String&quot;, # Human readable debug message associated with the issue.
122 &quot;fieldName&quot;: &quot;A String&quot;, # The name of the field for which this lint result is about. For nested messages `field_name` consists of names of the embedded fields separated by period character. The top-level qualifier is the input object to lint in the request. For example, the `field_name` value `condition.expression` identifies a lint result for the `expression` field of the provided condition.
123 &quot;level&quot;: &quot;A String&quot;, # The validation unit level.
124 &quot;locationOffset&quot;: 42, # 0-based character position of problematic construct within the object identified by `field_name`. Currently, this is populated only for condition expression.
125 &quot;severity&quot;: &quot;A String&quot;, # The validation unit severity.
126 &quot;validationUnitName&quot;: &quot;A String&quot;, # The validation unit name, for instance &quot;lintValidationUnits/ConditionComplexityCheck&quot;.
127 },
128 ],
129}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]130</div>
131
132<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]133 <code class="details" id="queryAuditableServices">queryAuditableServices(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]134 <pre>Returns a list of services that allow you to opt into audit logs that are not generated by default. To learn more about audit logs, see the [Logging documentation](https://cloud.google.com/logging/docs/audit).
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]135
136Args:
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]137 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]138 The object takes the form of:
139
140{ # A request to get the list of auditable services for a resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]141 &quot;fullResourceName&quot;: &quot;A String&quot;, # Required. The full resource name to query from the list of auditable services. The name follows the Google Cloud Platform resource format. For example, a Cloud Platform project with id `my-project` will be named `//cloudresourcemanager.googleapis.com/projects/my-project`.
142}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]143
144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 { # A response containing a list of auditable services for a resource.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame]153 &quot;services&quot;: [ # The auditable services for a resource.
154 { # Contains information about an auditable service.
155 &quot;name&quot;: &quot;A String&quot;, # Public name of the service. For example, the service name for Cloud IAM is &#x27;iam.googleapis.com&#x27;.
156 },
157 ],
158}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]159</div>
160
161</body></html>