Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / cc94ec86e652769e9d3d5cb6d6491efb8d76dd21 / . / docs / dyn / accesscontextmanager_v1.accessPolicies.accessLevels.html
blob: fd6808c05fc2beb07e0bfef8c11c90cc53139d2d [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="accesscontextmanager_v1.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1.accessPolicies.html">accessPolicies</a> . <a href="accesscontextmanager_v1.accessPolicies.accessLevels.html">accessLevels</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="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]82<p class="firstline">Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]83<p class="toc_element">
84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]85<p class="firstline">Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]86<p class="toc_element">
87 <code><a href="#get">get(name, accessLevelFormat=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]88<p class="firstline">Get an Access Level by resource name.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]89<p class="toc_element">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]90 <code><a href="#list">list(parent, accessLevelFormat=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]91<p class="firstline">List all Access Levels for an access policy.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]92<p class="toc_element">
93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
94<p class="firstline">Retrieves the next page of results.</p>
95<p class="toc_element">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]97<p class="firstline">Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.</p>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]98<p class="toc_element">
99 <code><a href="#replaceAll">replaceAll(parent, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]100<p class="firstline">Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.</p>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]101<h3>Method Details</h3>
102<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]103 <code class="details" id="close">close()</code>
104 <pre>Close httplib2 connections.</pre>
105</div>
106
107<div class="method">
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]108 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]109 <pre>Create an Access Level. The longrunning operation from this RPC will have a successful status once the Access Level has propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]110
111Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]112 parent: string, Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]113 body: object, The request body.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]114 The object takes the form of:
115
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]116{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]117 &quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]118 &quot;combiningFunction&quot;: &quot;A String&quot;, # How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]119 &quot;conditions&quot;: [ # Required. A list of requirements for the `AccessLevel` to be granted.
120 { # A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]121 &quot;devicePolicy&quot;: { # `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. # Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
122 &quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management levels.
123 &quot;A String&quot;,
124 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]125 &quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
126 &quot;A String&quot;,
127 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]128 &quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
129 { # A restriction on the OS type and version of devices making requests.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]130 &quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `&quot;major.minor.patch&quot;`. Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]131 &quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]132 &quot;requireVerifiedChromeOs&quot;: True or False, # Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.
133 },
134 ],
135 &quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]136 &quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
137 &quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]138 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]139 &quot;ipSubnetworks&quot;: [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas &quot;2001:db8::1/32&quot; is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
140 &quot;A String&quot;,
141 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]142 &quot;members&quot;: [ # The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
143 &quot;A String&quot;,
144 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]145 &quot;negate&quot;: True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
146 &quot;regions&quot;: [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
147 &quot;A String&quot;,
148 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]149 &quot;requiredAccessLevels&quot;: [ # A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]150 &quot;A String&quot;,
151 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]152 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]153 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]154 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]155 &quot;custom&quot;: { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec # A `CustomLevel` written in the Common Expression Language.
156 &quot;expr&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. # Required. A Cloud CEL expression evaluating to a boolean.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]157 &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.
158 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]159 &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.
160 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]161 },
162 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]163 &quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
164 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.
165 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]166}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]167
168 x__xgafv: string, V1 error format.
169 Allowed values
170 1 - v1 error format
171 2 - v2 error format
172
173Returns:
174 An object of the form:
175
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]176 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]177 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
178 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
179 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
180 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
181 {
182 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
183 },
184 ],
185 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
186 },
187 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
188 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
189 },
190 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
191 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
192 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
193 },
194}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]195</div>
196
197<div class="method">
198 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]199 <pre>Delete an Access Level by resource name. The longrunning operation from this RPC will have a successful status once the Access Level has been removed from long-lasting storage.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]200
201Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]202 name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]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
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]211 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]212 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
213 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
214 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
215 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
216 {
217 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
218 },
219 ],
220 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
221 },
222 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
223 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
224 },
225 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
226 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
227 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
228 },
229}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]230</div>
231
232<div class="method">
233 <code class="details" id="get">get(name, accessLevelFormat=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]234 <pre>Get an Access Level by resource name.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]235
236Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]237 name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required)
238 accessLevelFormat: string, Whether to return `BasicLevels` in the Cloud Common Expression Language rather than as `BasicLevels`. Defaults to AS_DEFINED, where Access Levels are returned as `BasicLevels` or `CustomLevels` based on how they were created. If set to CEL, all Access Levels are returned as `CustomLevels`. In the CEL case, `BasicLevels` are translated to equivalent `CustomLevels`.
239 Allowed values
240 LEVEL_FORMAT_UNSPECIFIED - The format was not specified.
241 AS_DEFINED - Uses the format the resource was defined in. BasicLevels are returned as BasicLevels, CustomLevels are returned as CustomLevels.
242 CEL - Use Cloud Common Expression Language when returning the resource. Both BasicLevels and CustomLevels are returned as CustomLevels.
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]243 x__xgafv: string, V1 error format.
244 Allowed values
245 1 - v1 error format
246 2 - v2 error format
247
248Returns:
249 An object of the form:
250
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]251 { # An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]252 &quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
253 &quot;combiningFunction&quot;: &quot;A String&quot;, # How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
254 &quot;conditions&quot;: [ # Required. A list of requirements for the `AccessLevel` to be granted.
255 { # A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
256 &quot;devicePolicy&quot;: { # `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. # Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
257 &quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management levels.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]258 &quot;A String&quot;,
259 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]260 &quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]261 &quot;A String&quot;,
262 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]263 &quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
264 { # A restriction on the OS type and version of devices making requests.
265 &quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `&quot;major.minor.patch&quot;`. Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
266 &quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
267 &quot;requireVerifiedChromeOs&quot;: True or False, # Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.
268 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]269 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]270 &quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
271 &quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
272 &quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]273 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]274 &quot;ipSubnetworks&quot;: [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas &quot;2001:db8::1/32&quot; is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
275 &quot;A String&quot;,
276 ],
277 &quot;members&quot;: [ # The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
278 &quot;A String&quot;,
279 ],
280 &quot;negate&quot;: True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
281 &quot;regions&quot;: [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
282 &quot;A String&quot;,
283 ],
284 &quot;requiredAccessLevels&quot;: [ # A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
285 &quot;A String&quot;,
286 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]287 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]288 ],
289 },
290 &quot;custom&quot;: { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec # A `CustomLevel` written in the Common Expression Language.
291 &quot;expr&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. # Required. A Cloud CEL expression evaluating to a boolean.
292 &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.
293 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
294 &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.
295 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]296 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]297 },
298 &quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
299 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.
300 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
301}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]302</div>
303
304<div class="method">
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]305 <code class="details" id="list">list(parent, accessLevelFormat=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]306 <pre>List all Access Levels for an access policy.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]307
308Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]309 parent: string, Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}` (required)
310 accessLevelFormat: string, Whether to return `BasicLevels` in the Cloud Common Expression language, as `CustomLevels`, rather than as `BasicLevels`. Defaults to returning `AccessLevels` in the format they were defined.
311 Allowed values
312 LEVEL_FORMAT_UNSPECIFIED - The format was not specified.
313 AS_DEFINED - Uses the format the resource was defined in. BasicLevels are returned as BasicLevels, CustomLevels are returned as CustomLevels.
314 CEL - Use Cloud Common Expression Language when returning the resource. Both BasicLevels and CustomLevels are returned as CustomLevels.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]315 pageSize: integer, Number of Access Levels to include in the list. Default 100.
Bu Sun Kim673ec5c2020-11-16 11:05:03 -0700[diff] [blame]316 pageToken: string, Next page token for the next batch of Access Level instances. Defaults to the first page of results.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]317 x__xgafv: string, V1 error format.
318 Allowed values
319 1 - v1 error format
320 2 - v2 error format
321
322Returns:
323 An object of the form:
324
325 { # A response to `ListAccessLevelsRequest`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]326 &quot;accessLevels&quot;: [ # List of the Access Level instances.
327 { # An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.
328 &quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
329 &quot;combiningFunction&quot;: &quot;A String&quot;, # How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
330 &quot;conditions&quot;: [ # Required. A list of requirements for the `AccessLevel` to be granted.
331 { # A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
332 &quot;devicePolicy&quot;: { # `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. # Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
333 &quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management levels.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]334 &quot;A String&quot;,
335 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]336 &quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]337 &quot;A String&quot;,
338 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]339 &quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
340 { # A restriction on the OS type and version of devices making requests.
341 &quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `&quot;major.minor.patch&quot;`. Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
342 &quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
343 &quot;requireVerifiedChromeOs&quot;: True or False, # Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.
344 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]345 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]346 &quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
347 &quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
348 &quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]349 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]350 &quot;ipSubnetworks&quot;: [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas &quot;2001:db8::1/32&quot; is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
351 &quot;A String&quot;,
352 ],
353 &quot;members&quot;: [ # The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
354 &quot;A String&quot;,
355 ],
356 &quot;negate&quot;: True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
357 &quot;regions&quot;: [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
358 &quot;A String&quot;,
359 ],
360 &quot;requiredAccessLevels&quot;: [ # A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
361 &quot;A String&quot;,
362 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]363 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]364 ],
365 },
366 &quot;custom&quot;: { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec # A `CustomLevel` written in the Common Expression Language.
367 &quot;expr&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. # Required. A Cloud CEL expression evaluating to a boolean.
368 &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.
369 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
370 &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.
371 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]372 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]373 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]374 &quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
375 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.
376 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
377 },
378 ],
379 &quot;nextPageToken&quot;: &quot;A String&quot;, # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.
380}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]381</div>
382
383<div class="method">
384 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
385 <pre>Retrieves the next page of results.
386
387Args:
388 previous_request: The request for the previous page. (required)
389 previous_response: The response from the request for the previous page. (required)
390
391Returns:
Bu Sun Kim65020912020-05-20 12:08:20 -0700[diff] [blame]392 A request object that you can call &#x27;execute()&#x27; on to request the next
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]393 page. Returns None if there are no more items in the collection.
394 </pre>
395</div>
396
397<div class="method">
398 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]399 <pre>Update an Access Level. The longrunning operation from this RPC will have a successful status once the changes to the Access Level have propagated to long-lasting storage. Access Levels containing errors will result in an error response for the first error encountered.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]400
401Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]402 name: string, Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters. (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]403 body: object, The request body.
404 The object takes the form of:
405
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]406{ # An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]407 &quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]408 &quot;combiningFunction&quot;: &quot;A String&quot;, # How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]409 &quot;conditions&quot;: [ # Required. A list of requirements for the `AccessLevel` to be granted.
410 { # A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]411 &quot;devicePolicy&quot;: { # `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. # Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
412 &quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management levels.
413 &quot;A String&quot;,
414 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]415 &quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
416 &quot;A String&quot;,
417 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]418 &quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
419 { # A restriction on the OS type and version of devices making requests.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]420 &quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `&quot;major.minor.patch&quot;`. Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]421 &quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]422 &quot;requireVerifiedChromeOs&quot;: True or False, # Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.
423 },
424 ],
425 &quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]426 &quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
427 &quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]428 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]429 &quot;ipSubnetworks&quot;: [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas &quot;2001:db8::1/32&quot; is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
430 &quot;A String&quot;,
431 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]432 &quot;members&quot;: [ # The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
433 &quot;A String&quot;,
434 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]435 &quot;negate&quot;: True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
436 &quot;regions&quot;: [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
437 &quot;A String&quot;,
438 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]439 &quot;requiredAccessLevels&quot;: [ # A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]440 &quot;A String&quot;,
441 ],
Yoshi Automation Bot0d561ef2020-11-25 07:50:41 -0800[diff] [blame]442 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]443 ],
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]444 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]445 &quot;custom&quot;: { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec # A `CustomLevel` written in the Common Expression Language.
446 &quot;expr&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. # Required. A Cloud CEL expression evaluating to a boolean.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]447 &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.
448 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]449 &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.
450 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]451 },
452 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]453 &quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
454 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.
455 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]456}
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]457
458 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty.
459 x__xgafv: string, V1 error format.
460 Allowed values
461 1 - v1 error format
462 2 - v2 error format
463
464Returns:
465 An object of the form:
466
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]467 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]468 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
469 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
470 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
471 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
472 {
473 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
474 },
475 ],
476 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
477 },
478 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
479 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
480 },
481 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
482 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
483 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
484 },
485}</pre>
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]486</div>
487
488<div class="method">
489 <code class="details" id="replaceAll">replaceAll(parent, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]490 <pre>Replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically. The longrunning operation from this RPC will have a successful status once all replacements have propagated to long-lasting storage. Replacements containing errors will result in an error response for the first error encountered. Replacement will be cancelled on error, existing Access Levels will not be affected. Operation.response field will contain ReplaceAccessLevelsResponse. Removing Access Levels contained in existing Service Perimeters will result in error.
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]491
492Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]493 parent: string, Required. Resource name for the access policy which owns these Access Levels. Format: `accessPolicies/{policy_id}` (required)
Dan O'Mearadd494642020-05-01 07:42:23 -0700[diff] [blame]494 body: object, The request body.
495 The object takes the form of:
496
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]497{ # A request to replace all existing Access Levels in an Access Policy with the Access Levels provided. This is done atomically.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]498 &quot;accessLevels&quot;: [ # Required. The desired Access Levels that should replace all existing Access Levels in the Access Policy.
499 { # An `AccessLevel` is a label that can be applied to requests to Google Cloud services, along with a list of requirements necessary for the label to be applied.
500 &quot;basic&quot;: { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.
501 &quot;combiningFunction&quot;: &quot;A String&quot;, # How the `conditions` list should be combined to determine if a request is granted this `AccessLevel`. If AND is used, each `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. If OR is used, at least one `Condition` in `conditions` must be satisfied for the `AccessLevel` to be applied. Default behavior is AND.
502 &quot;conditions&quot;: [ # Required. A list of requirements for the `AccessLevel` to be granted.
503 { # A condition necessary for an `AccessLevel` to be granted. The Condition is an AND over its fields. So a Condition is true if: 1) the request IP is from one of the listed subnetworks AND 2) the originating device complies with the listed device policy AND 3) all listed access levels are granted AND 4) the request was sent at a time allowed by the DateTimeRestriction.
504 &quot;devicePolicy&quot;: { # `DevicePolicy` specifies device specific restrictions necessary to acquire a given access level. A `DevicePolicy` specifies requirements for requests from devices to be granted access levels, it does not do any enforcement on the device. `DevicePolicy` acts as an AND over all specified fields, and each repeated field is an OR over its elements. Any unset fields are ignored. For example, if the proto is { os_type : DESKTOP_WINDOWS, os_type : DESKTOP_LINUX, encryption_status: ENCRYPTED}, then the DevicePolicy will be true for requests originating from encrypted Linux desktops and encrypted Windows desktops. # Device specific restrictions, all restrictions must hold for the Condition to be true. If not specified, all devices are allowed.
505 &quot;allowedDeviceManagementLevels&quot;: [ # Allowed device management levels, an empty list allows all management levels.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]506 &quot;A String&quot;,
507 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]508 &quot;allowedEncryptionStatuses&quot;: [ # Allowed encryptions statuses, an empty list allows all statuses.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]509 &quot;A String&quot;,
510 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]511 &quot;osConstraints&quot;: [ # Allowed OS versions, an empty list allows all types and all versions.
512 { # A restriction on the OS type and version of devices making requests.
513 &quot;minimumVersion&quot;: &quot;A String&quot;, # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `&quot;major.minor.patch&quot;`. Examples: `&quot;10.5.301&quot;`, `&quot;9.2.1&quot;`.
514 &quot;osType&quot;: &quot;A String&quot;, # Required. The allowed OS type.
515 &quot;requireVerifiedChromeOs&quot;: True or False, # Only allows requests from devices with a verified Chrome OS. Verifications includes requirements that the device is enterprise-managed, conformant to domain policies, and the caller has permission to call the API targeted by the request.
516 },
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]517 ],
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]518 &quot;requireAdminApproval&quot;: True or False, # Whether the device needs to be approved by the customer admin.
519 &quot;requireCorpOwned&quot;: True or False, # Whether the device needs to be corp owned.
520 &quot;requireScreenlock&quot;: True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]521 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]522 &quot;ipSubnetworks&quot;: [ # CIDR block IP subnetwork specification. May be IPv4 or IPv6. Note that for a CIDR IP address block, the specified IP address portion must be properly truncated (i.e. all the host bits must be zero) or the input is considered malformed. For example, &quot;192.0.2.0/24&quot; is accepted but &quot;192.0.2.1/24&quot; is not. Similarly, for IPv6, &quot;2001:db8::/32&quot; is accepted whereas &quot;2001:db8::1/32&quot; is not. The originating IP of a request must be in one of the listed subnets in order for this Condition to be true. If empty, all IP addresses are allowed.
523 &quot;A String&quot;,
524 ],
525 &quot;members&quot;: [ # The request must be made by one of the provided user or service accounts. Groups are not supported. Syntax: `user:{emailid}` `serviceAccount:{emailid}` If not specified, a request may come from any user.
526 &quot;A String&quot;,
527 ],
528 &quot;negate&quot;: True or False, # Whether to negate the Condition. If true, the Condition becomes a NAND over its non-empty fields, each field must be false for the Condition overall to be satisfied. Defaults to false.
529 &quot;regions&quot;: [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.
530 &quot;A String&quot;,
531 ],
532 &quot;requiredAccessLevels&quot;: [ # A list of other access levels defined in the same `Policy`, referenced by resource name. Referencing an `AccessLevel` which does not exist is an error. All access levels listed must be granted for the Condition to be true. Example: &quot;`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME&quot;`
533 &quot;A String&quot;,
534 ],
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]535 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]536 ],
537 },
538 &quot;custom&quot;: { # `CustomLevel` is an `AccessLevel` using the Cloud Common Expression Language to represent the necessary conditions for the level to apply to a request. See CEL spec at: https://github.com/google/cel-spec # A `CustomLevel` written in the Common Expression Language.
539 &quot;expr&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. # Required. A Cloud CEL expression evaluating to a boolean.
540 &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.
541 &quot;expression&quot;: &quot;A String&quot;, # Textual representation of an expression in Common Expression Language syntax.
542 &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.
543 &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.
Yoshi Automation Bot0bf565c2020-12-09 08:56:03 -0800[diff] [blame]544 },
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800[diff] [blame]545 },
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]546 &quot;description&quot;: &quot;A String&quot;, # Description of the `AccessLevel` and its use. Does not affect behavior.
547 &quot;name&quot;: &quot;A String&quot;, # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and &#x27;_&#x27;. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters.
548 &quot;title&quot;: &quot;A String&quot;, # Human readable title. Must be unique within the Policy.
549 },
550 ],
551 &quot;etag&quot;: &quot;A String&quot;, # Optional. The etag for the version of the Access Policy that this replace operation is to be performed on. If, at the time of replace, the etag for the Access Policy stored in Access Context Manager is different from the specified etag, then the replace operation will not be performed and the call will fail. This field is not required. If etag is not provided, the operation will be performed as if a valid etag is provided.
552}
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]553
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]554 x__xgafv: string, V1 error format.
555 Allowed values
556 1 - v1 error format
557 2 - v2 error format
558
559Returns:
560 An object of the form:
561
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700[diff] [blame]562 { # This resource represents a long-running operation that is the result of a network API call.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800[diff] [blame^]563 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
564 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
565 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
566 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
567 {
568 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
569 },
570 ],
571 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
572 },
573 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
574 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
575 },
576 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
577 &quot;response&quot;: { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
578 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
579 },
580}</pre>
Bu Sun Kim715bd7f2019-06-14 16:50:42 -0700[diff] [blame]581</div>
582
583</body></html>