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_v1beta.html">Access Context Manager API</a> . <a href="accesscontextmanager_v1beta.accessPolicies.html">accessPolicies</a> . <a href="accesscontextmanager_v1beta.accessPolicies.accessLevels.html">accessLevels</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 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> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 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> 86<p class="toc_element"> 87 <code><a href="#get">get(name, accessLevelFormat=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Get an Access Level by resource name.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, accessLevelFormat=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">List all Access Levels for an access policy.</p> 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"> 96 <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> 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> 98<h3>Method Details</h3> 99<div class="method"> 100 <code class="details" id="close">close()</code> 101 <pre>Close httplib2 connections.</pre> 102</div> 103 104<div class="method"> 105 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 106 <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. 107 108Args: 109 parent: string, Required. Resource name for the access policy which owns this Access Level. Format: `accessPolicies/{policy_id}` (required) 110 body: object, The request body. 111 The object takes the form of: 112 113{ # 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. 114 "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`. 115 "combiningFunction": "A String", # 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. 116 "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted. 117 { # 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. 118 "devicePolicy": { # `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. 119 "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels. 120 "A String", 121 ], 122 "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses. 123 "A String", 124 ], 125 "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions. 126 { # A restriction on the OS type and version of devices making requests. 127 "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. 128 "osType": "A String", # Required. The allowed OS type. 129 "requireVerifiedChromeOs": 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. 130 }, 131 ], 132 "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin. 133 "requireCorpOwned": True or False, # Whether the device needs to be corp owned. 134 "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. 135 }, 136 "ipSubnetworks": [ # 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, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" 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. 137 "A String", 138 ], 139 "members": [ # 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. 140 "A String", 141 ], 142 "negate": 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. 143 "regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. 144 "A String", 145 ], 146 "requiredAccessLevels": [ # 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: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` 147 "A String", 148 ], 149 }, 150 ], 151 }, 152 "custom": { # `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. 153 "expr": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. 154 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 155 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 156 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 157 "title": "A String", # 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. 158 }, 159 }, 160 "description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior. 161 "name": "A String", # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length // of the `short_name` component is 50 characters. 162 "title": "A String", # Human readable title. Must be unique within the Policy. 163} 164 165 x__xgafv: string, V1 error format. 166 Allowed values 167 1 - v1 error format 168 2 - v2 error format 169 170Returns: 171 An object of the form: 172 173 { # This resource represents a long-running operation that is the result of a network API call. 174 "done": 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. 175 "error": { # 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. 176 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 177 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 178 { 179 "a_key": "", # Properties of the object. Contains field @type with type URL. 180 }, 181 ], 182 "message": "A String", # 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. 183 }, 184 "metadata": { # 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. 185 "a_key": "", # Properties of the object. Contains field @type with type URL. 186 }, 187 "name": "A String", # 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}`. 188 "response": { # 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`. 189 "a_key": "", # Properties of the object. Contains field @type with type URL. 190 }, 191}</pre> 192</div> 193 194<div class="method"> 195 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 196 <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. 197 198Args: 199 name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required) 200 x__xgafv: string, V1 error format. 201 Allowed values 202 1 - v1 error format 203 2 - v2 error format 204 205Returns: 206 An object of the form: 207 208 { # This resource represents a long-running operation that is the result of a network API call. 209 "done": 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. 210 "error": { # 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. 211 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 212 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 213 { 214 "a_key": "", # Properties of the object. Contains field @type with type URL. 215 }, 216 ], 217 "message": "A String", # 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. 218 }, 219 "metadata": { # 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. 220 "a_key": "", # Properties of the object. Contains field @type with type URL. 221 }, 222 "name": "A String", # 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}`. 223 "response": { # 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`. 224 "a_key": "", # Properties of the object. Contains field @type with type URL. 225 }, 226}</pre> 227</div> 228 229<div class="method"> 230 <code class="details" id="get">get(name, accessLevelFormat=None, x__xgafv=None)</code> 231 <pre>Get an Access Level by resource name. 232 233Args: 234 name: string, Required. Resource name for the Access Level. Format: `accessPolicies/{policy_id}/accessLevels/{access_level_id}` (required) 235 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`. 236 Allowed values 237 LEVEL_FORMAT_UNSPECIFIED - The format was not specified. 238 AS_DEFINED - Uses the format the resource was defined in. BasicLevels are returned as BasicLevels, CustomLevels are returned as CustomLevels. 239 CEL - Use Cloud Common Expression Language when returning the resource. Both BasicLevels and CustomLevels are returned as CustomLevels. 240 x__xgafv: string, V1 error format. 241 Allowed values 242 1 - v1 error format 243 2 - v2 error format 244 245Returns: 246 An object of the form: 247 248 { # 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. 249 "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`. 250 "combiningFunction": "A String", # 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. 251 "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted. 252 { # 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. 253 "devicePolicy": { # `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. 254 "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels. 255 "A String", 256 ], 257 "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses. 258 "A String", 259 ], 260 "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions. 261 { # A restriction on the OS type and version of devices making requests. 262 "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. 263 "osType": "A String", # Required. The allowed OS type. 264 "requireVerifiedChromeOs": 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. 265 }, 266 ], 267 "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin. 268 "requireCorpOwned": True or False, # Whether the device needs to be corp owned. 269 "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. 270 }, 271 "ipSubnetworks": [ # 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, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" 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. 272 "A String", 273 ], 274 "members": [ # 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. 275 "A String", 276 ], 277 "negate": 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. 278 "regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. 279 "A String", 280 ], 281 "requiredAccessLevels": [ # 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: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` 282 "A String", 283 ], 284 }, 285 ], 286 }, 287 "custom": { # `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. 288 "expr": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. 289 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 290 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 291 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 292 "title": "A String", # 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. 293 }, 294 }, 295 "description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior. 296 "name": "A String", # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length // of the `short_name` component is 50 characters. 297 "title": "A String", # Human readable title. Must be unique within the Policy. 298}</pre> 299</div> 300 301<div class="method"> 302 <code class="details" id="list">list(parent, accessLevelFormat=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 303 <pre>List all Access Levels for an access policy. 304 305Args: 306 parent: string, Required. Resource name for the access policy to list Access Levels from. Format: `accessPolicies/{policy_id}` (required) 307 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. 308 Allowed values 309 LEVEL_FORMAT_UNSPECIFIED - The format was not specified. 310 AS_DEFINED - Uses the format the resource was defined in. BasicLevels are returned as BasicLevels, CustomLevels are returned as CustomLevels. 311 CEL - Use Cloud Common Expression Language when returning the resource. Both BasicLevels and CustomLevels are returned as CustomLevels. 312 pageSize: integer, Number of Access Levels to include in the list. Default 100. 313 pageToken: string, Next page token for the next batch of Access Level instances. Defaults to the first page of results. 314 x__xgafv: string, V1 error format. 315 Allowed values 316 1 - v1 error format 317 2 - v2 error format 318 319Returns: 320 An object of the form: 321 322 { # A response to `ListAccessLevelsRequest`. 323 "accessLevels": [ # List of the Access Level instances. 324 { # 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. 325 "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`. 326 "combiningFunction": "A String", # 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. 327 "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted. 328 { # 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. 329 "devicePolicy": { # `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. 330 "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels. 331 "A String", 332 ], 333 "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses. 334 "A String", 335 ], 336 "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions. 337 { # A restriction on the OS type and version of devices making requests. 338 "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. 339 "osType": "A String", # Required. The allowed OS type. 340 "requireVerifiedChromeOs": 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. 341 }, 342 ], 343 "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin. 344 "requireCorpOwned": True or False, # Whether the device needs to be corp owned. 345 "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. 346 }, 347 "ipSubnetworks": [ # 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, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" 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. 348 "A String", 349 ], 350 "members": [ # 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. 351 "A String", 352 ], 353 "negate": 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. 354 "regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. 355 "A String", 356 ], 357 "requiredAccessLevels": [ # 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: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` 358 "A String", 359 ], 360 }, 361 ], 362 }, 363 "custom": { # `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. 364 "expr": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. 365 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 366 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 367 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 368 "title": "A String", # 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. 369 }, 370 }, 371 "description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior. 372 "name": "A String", # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length // of the `short_name` component is 50 characters. 373 "title": "A String", # Human readable title. Must be unique within the Policy. 374 }, 375 ], 376 "nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain. 377}</pre> 378</div> 379 380<div class="method"> 381 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 382 <pre>Retrieves the next page of results. 383 384Args: 385 previous_request: The request for the previous page. (required) 386 previous_response: The response from the request for the previous page. (required) 387 388Returns: 389 A request object that you can call 'execute()' on to request the next 390 page. Returns None if there are no more items in the collection. 391 </pre> 392</div> 393 394<div class="method"> 395 <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> 396 <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. 397 398Args: 399 name: string, Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length // of the `short_name` component is 50 characters. (required) 400 body: object, The request body. 401 The object takes the form of: 402 403{ # 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. 404 "basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`. 405 "combiningFunction": "A String", # 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. 406 "conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted. 407 { # 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. 408 "devicePolicy": { # `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. 409 "allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels. 410 "A String", 411 ], 412 "allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses. 413 "A String", 414 ], 415 "osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions. 416 { # A restriction on the OS type and version of devices making requests. 417 "minimumVersion": "A String", # The minimum allowed OS version. If not set, any version of this OS satisfies the constraint. Format: `"major.minor.patch"`. Examples: `"10.5.301"`, `"9.2.1"`. 418 "osType": "A String", # Required. The allowed OS type. 419 "requireVerifiedChromeOs": 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. 420 }, 421 ], 422 "requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin. 423 "requireCorpOwned": True or False, # Whether the device needs to be corp owned. 424 "requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`. 425 }, 426 "ipSubnetworks": [ # 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, "192.0.2.0/24" is accepted but "192.0.2.1/24" is not. Similarly, for IPv6, "2001:db8::/32" is accepted whereas "2001:db8::1/32" 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. 427 "A String", 428 ], 429 "members": [ # 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. 430 "A String", 431 ], 432 "negate": 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. 433 "regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes. 434 "A String", 435 ], 436 "requiredAccessLevels": [ # 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: "`accessPolicies/MY_POLICY/accessLevels/LEVEL_NAME"` 437 "A String", 438 ], 439 }, 440 ], 441 }, 442 "custom": { # `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. 443 "expr": { # 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: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" 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. 444 "description": "A String", # Optional. Description of the expression. This is a longer text which describes the expression, e.g. when hovered over it in a UI. 445 "expression": "A String", # Textual representation of an expression in Common Expression Language syntax. 446 "location": "A String", # Optional. String indicating the location of the expression for error reporting, e.g. a file name and a position in the file. 447 "title": "A String", # 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. 448 }, 449 }, 450 "description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior. 451 "name": "A String", # Required. Resource name for the Access Level. The `short_name` component must begin with a letter and only include alphanumeric and '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length // of the `short_name` component is 50 characters. 452 "title": "A String", # Human readable title. Must be unique within the Policy. 453} 454 455 updateMask: string, Required. Mask to control which fields get updated. Must be non-empty. 456 x__xgafv: string, V1 error format. 457 Allowed values 458 1 - v1 error format 459 2 - v2 error format 460 461Returns: 462 An object of the form: 463 464 { # This resource represents a long-running operation that is the result of a network API call. 465 "done": 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. 466 "error": { # 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. 467 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 468 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 469 { 470 "a_key": "", # Properties of the object. Contains field @type with type URL. 471 }, 472 ], 473 "message": "A String", # 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. 474 }, 475 "metadata": { # 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. 476 "a_key": "", # Properties of the object. Contains field @type with type URL. 477 }, 478 "name": "A String", # 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}`. 479 "response": { # 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`. 480 "a_key": "", # Properties of the object. Contains field @type with type URL. 481 }, 482}</pre> 483</div> 484 485</body></html>