Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 32d1c597b364e2641eca33ccf6df802bb218eea1 / . / docs / dyn / sasportal_v1alpha1.policies.html
blob: c40829835791b4b376c4ddd0d0a5b7bb89682e94 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -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="sasportal_v1alpha1.html">SAS Portal API</a> . <a href="sasportal_v1alpha1.policies.html">policies</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">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]81 <code><a href="#get">get(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#set">set(body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#test">test(body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns permissions that a caller has on the specified resource.</p>
89<h3>Method Details</h3>
90<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91 <code class="details" id="close">close()</code>
92 <pre>Close httplib2 connections.</pre>
93</div>
94
95<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]96 <code class="details" id="get">get(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97 <pre>Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]98
99Args:
100 body: object, The request body.
101 The object takes the form of:
102
103{ # Request message for `GetPolicy` method.
104 &quot;resource&quot;: &quot;A String&quot;, # Required. The resource for which the policy is being requested.
105 }
106
107 x__xgafv: string, V1 error format.
108 Allowed values
109 1 - v1 error format
110 2 - v2 error format
111
112Returns:
113 An object of the form:
114
115 { # Defines an access control policy to the resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]116 &quot;etag&quot;: &quot;A String&quot;, # The [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 [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]117 &quot;assignments&quot;: [
118 { # Associates `members` with a `role`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]119 &quot;role&quot;: &quot;A String&quot;, # Required. Role that is assigned to `members`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]120 &quot;members&quot;: [ # The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]121 &quot;A String&quot;,
122 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]123 },
124 ],
125 }</pre>
126</div>
127
128<div class="method">
129 <code class="details" id="set">set(body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]130 <pre>Sets the access control policy on the specified resource. Replaces any existing policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]131
132Args:
133 body: object, The request body.
134 The object takes the form of:
135
136{ # Request message for `SetPolicy` method.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]137 &quot;policy&quot;: { # Defines an access control policy to the resources. # Required. The policy to be applied to the `resource`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]138 &quot;etag&quot;: &quot;A String&quot;, # The [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 [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]139 &quot;assignments&quot;: [
140 { # Associates `members` with a `role`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]141 &quot;role&quot;: &quot;A String&quot;, # Required. Role that is assigned to `members`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]142 &quot;members&quot;: [ # The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]143 &quot;A String&quot;,
144 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]145 },
146 ],
147 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]148 &quot;resource&quot;: &quot;A String&quot;, # Required. The resource for which the policy is being specified. This policy replaces any existing policy.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]149 }
150
151 x__xgafv: string, V1 error format.
152 Allowed values
153 1 - v1 error format
154 2 - v2 error format
155
156Returns:
157 An object of the form:
158
159 { # Defines an access control policy to the resources.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]160 &quot;etag&quot;: &quot;A String&quot;, # The [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 [GetPolicy], and systems are expected to put that etag in the request to [SetPolicy] to ensure that their change will be applied to the same version of the policy. If no [etag] is provided in the call to [SetPolicy], then the existing policy is overwritten blindly.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]161 &quot;assignments&quot;: [
162 { # Associates `members` with a `role`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]163 &quot;role&quot;: &quot;A String&quot;, # Required. Role that is assigned to `members`.
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]164 &quot;members&quot;: [ # The identities the role is assigned to. It can have the following values: * `{user_email}`: An email address that represents a specific Google account. For example: `alice@gmail.com`. * `{group_email}`: An email address that represents a Google group. For example, `viewers@gmail.com`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]165 &quot;A String&quot;,
166 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]167 },
168 ],
169 }</pre>
170</div>
171
172<div class="method">
173 <code class="details" id="test">test(body=None, x__xgafv=None)</code>
174 <pre>Returns permissions that a caller has on the specified resource.
175
176Args:
177 body: object, The request body.
178 The object takes the form of:
179
180{ # Request message for `TestPermissions` method.
Yoshi Automation Botc2228be2020-11-24 15:48:03 -0800[diff] [blame]181 &quot;resource&quot;: &quot;A String&quot;, # Required. The resource for which the permissions are being requested.
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]182 &quot;permissions&quot;: [ # The set of permissions to check for the `resource`.
183 &quot;A String&quot;,
184 ],
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]185 }
186
187 x__xgafv: string, V1 error format.
188 Allowed values
189 1 - v1 error format
190 2 - v2 error format
191
192Returns:
193 An object of the form:
194
195 { # Response message for `TestPermissions` method.
196 &quot;permissions&quot;: [ # A set of permissions that the caller is allowed.
197 &quot;A String&quot;,
198 ],
199 }</pre>
200</div>
201
202</body></html>