Blame - docs/dyn/accesscontextmanager_v1.accessPolicies.accessLevels.html - platform/external/python/google-api-python-client

2020-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

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

81

<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

83

84

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

86

87

<code><a href="#get">get(name, accessLevelFormat=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

88

<p class="firstline">Get an Access Level by resource name.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

89

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

90

<code><a href="#list">list(parent, accessLevelFormat=None, pageToken=None, pageSize=None, x__xgafv=None)</a></code></p>

91

<p class="firstline">List all Access Levels for an access policy.</p>

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

92

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

Dan O'Meara

2020-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 Frenkel

2020-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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

98

99

<code><a href="#replaceAll">replaceAll(parent, body=None, x__xgafv=None)</a></code></p>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

101

<h3>Method Details</h3>

102

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

103

<code class="details" id="close">close()</code>

104

<pre>Close httplib2 connections.</pre>

</div>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

108

<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

110

111

Args:

Dmitry Frenkel

2020-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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

113

body: object, The request body.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

114

The object takes the form of:

115

Dmitry Frenkel

2020-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.

117

"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.

118

"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.

119

"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.

120

"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.

121

"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.

122

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

123

},

124

},

125

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

126

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

127

{ # 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.

128

"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.

129

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

130

"A String",

131

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

132

"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.

133

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

134

{ # A restriction on the OS type and version of devices making requests.

135

"osType": "A String", # Required. The allowed OS type.

136

"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"`.

137

"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.

138

},

139

],

140

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels.

141

"A String",

142

],

143

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.

144

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

145

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

146

"A String",

147

],

148

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

149

},

150

"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.

151

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

152

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

153

"regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

154

"A String",

155

],

156

"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"`

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

157

"A String",

158

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

159

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

160

],

161

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

162

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

163

"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.

164

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

165

"title": "A String", # Human readable title. Must be unique within the Policy.

166

}

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

167

168

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

175

Dmitry Frenkel

2020-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.

177

"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.

178

"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.

179

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

180

{

181

"a_key": "", # Properties of the object. Contains field @type with type URL.

182

},

183

],

184

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

185

},

186

"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.

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

"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.

192

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

193

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="delete">delete(name, x__xgafv=None)</code>

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

200

201

Args:

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

203

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

210

Dmitry Frenkel

2020-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.

212

"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.

213

"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.

214

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

215

{

216

"a_key": "", # Properties of the object. Contains field @type with type URL.

217

},

218

],

219

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

220

},

221

"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.

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

"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.

227

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

228

},

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, accessLevelFormat=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

234

<pre>Get an Access Level by resource name.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

235

236

Args:

Dmitry Frenkel

2020-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 Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

243

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

250

Dmitry Frenkel

2020-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.

252

"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.

253

"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.

254

"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.

255

"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.

256

"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.

257

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

258

},

259

},

260

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

261

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

262

{ # 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.

263

"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.

264

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

265

"A String",

266

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

267

"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.

268

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

269

{ # A restriction on the OS type and version of devices making requests.

270

"osType": "A String", # Required. The allowed OS type.

271

"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"`.

272

"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.

273

},

274

],

275

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels.

276

"A String",

277

],

278

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.

279

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

280

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

281

"A String",

282

],

283

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

284

},

285

"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.

286

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

287

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

288

"regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

289

"A String",

290

],

291

"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"`

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

292

"A String",

293

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

294

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

295

],

296

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

297

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

298

"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.

299

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

300

"title": "A String", # Human readable title. Must be unique within the Policy.

301

}</pre>

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

</div>

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

305

<code class="details" id="list">list(parent, accessLevelFormat=None, pageToken=None, pageSize=None, x__xgafv=None)</code>

306

<pre>List all Access Levels for an access policy.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

307

308

Args:

Dmitry Frenkel

2020-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.

315

pageToken: string, Next page token for the next batch of Access Level instances. Defaults to the first page of results.

316

pageSize: integer, Number of Access Levels to include in the list. Default 100.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

317

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

324

325

{ # A response to `ListAccessLevelsRequest`.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

326

"nextPageToken": "A String", # The pagination token to retrieve the next page of results. If the value is empty, no further results remain.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

327

"accessLevels": [ # List of the Access Level instances.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

328

{ # 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.

329

"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.

330

"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.

331

"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.

332

"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.

333

"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.

334

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

335

},

336

},

337

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

338

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

339

{ # 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.

340

"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.

341

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

342

"A String",

343

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

344

"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.

345

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

346

{ # A restriction on the OS type and version of devices making requests.

347

"osType": "A String", # Required. The allowed OS type.

348

"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"`.

349

"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.

350

},

351

],

352

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels.

353

"A String",

354

],

355

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.

356

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

357

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

358

"A String",

359

],

360

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

361

},

362

"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.

363

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

364

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

365

"regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

366

"A String",

367

],

368

"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"`

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

369

"A String",

370

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

371

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

372

],

373

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

374

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

375

"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.

376

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

377

"title": "A String", # Human readable title. Must be unique within the Policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

378

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

385

<pre>Retrieves the next page of results.

386

387

Args:

388

previous_request: The request for the previous page. (required)

389

previous_response: The response from the request for the previous page. (required)

390

391

Returns:

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

392

A request object that you can call 'execute()' on to request the next

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

393

page. Returns None if there are no more items in the collection.

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

400

401

Args:

Dmitry Frenkel

2020-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 '_'. Format: `accessPolicies/{policy_id}/accessLevels/{short_name}`. The maximum length of the `short_name` component is 50 characters. (required)

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

403

body: object, The request body.

404

The object takes the form of:

405

Dmitry Frenkel

2020-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.

407

"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.

408

"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.

409

"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.

410

"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.

411

"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.

412

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

413

},

414

},

415

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

416

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

417

{ # 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.

418

"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.

419

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

420

"A String",

421

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

422

"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.

423

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

424

{ # A restriction on the OS type and version of devices making requests.

425

"osType": "A String", # Required. The allowed OS type.

426

"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"`.

427

"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.

428

},

429

],

430

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels.

431

"A String",

432

],

433

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.

434

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

435

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

436

"A String",

437

],

438

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

439

},

440

"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.

441

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

442

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

443

"regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

444

"A String",

445

],

446

"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"`

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

447

"A String",

448

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

449

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

450

],

451

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

452

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

453

"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.

454

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

455

"title": "A String", # Human readable title. Must be unique within the Policy.

456

}

Dan O'Meara

2020-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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

466

Dmitry Frenkel

2020-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.

468

"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.

469

"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.

470

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

471

{

472

"a_key": "", # Properties of the object. Contains field @type with type URL.

473

},

474

],

475

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

476

},

477

"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.

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

"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.

483

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

484

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

}</pre>

</div>

<code class="details" id="replaceAll">replaceAll(parent, body=None, x__xgafv=None)</code>

Dmitry Frenkel

2020-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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

491

492

Args:

Dmitry Frenkel

2020-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'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

494

body: object, The request body.

495

The object takes the form of:

496

Dmitry Frenkel

2020-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.

498

"etag": "A String", # 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.

499

"accessLevels": [ # Required. The desired Access Levels that should replace all existing Access Levels in the Access Policy.

500

{ # 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.

501

"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.

502

"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.

503

"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.

504

"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.

505

"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.

506

"expression": "A String", # Textual representation of an expression in Common Expression Language syntax.

507

},

508

},

509

"basic": { # `BasicLevel` is an `AccessLevel` using a set of recommended features. # A `BasicLevel` composed of `Conditions`.

510

"conditions": [ # Required. A list of requirements for the `AccessLevel` to be granted.

511

{ # 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.

512

"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.

513

"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.

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

514

"A String",

515

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

516

"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.

517

"osConstraints": [ # Allowed OS versions, an empty list allows all types and all versions.

518

{ # A restriction on the OS type and version of devices making requests.

519

"osType": "A String", # Required. The allowed OS type.

520

"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"`.

521

"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.

522

},

523

],

524

"allowedDeviceManagementLevels": [ # Allowed device management levels, an empty list allows all management levels.

525

"A String",

526

],

527

"requireScreenlock": True or False, # Whether or not screenlock is required for the DevicePolicy to be true. Defaults to `false`.

528

"requireAdminApproval": True or False, # Whether the device needs to be approved by the customer admin.

529

"allowedEncryptionStatuses": [ # Allowed encryptions statuses, an empty list allows all statuses.

530

"A String",

531

],

532

"requireCorpOwned": True or False, # Whether the device needs to be corp owned.

533

},

534

"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.

535

"A String",

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

536

],

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

537

"regions": [ # The request must originate from one of the provided countries/regions. Must be valid ISO 3166-1 alpha-2 codes.

538

"A String",

539

],

540

"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"`

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

541

"A String",

542

],

Bu Sun Kim

2020-05-27 12:20:54 -0700

[diff] [blame]

543

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

544

],

545

"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.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

546

},

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

547

"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.

548

"description": "A String", # Description of the `AccessLevel` and its use. Does not affect behavior.

549

"title": "A String", # Human readable title. Must be unique within the Policy.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame]

550

},

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

551

],

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

552

}

553

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

554

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

561

Dmitry Frenkel

2020-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.

563

"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.

564

"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.

565

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

566

{

567

"a_key": "", # Properties of the object. Contains field @type with type URL.

568

},

569

],

570

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Dmitry Frenkel

2020-10-06 16:46:05 -0700

[diff] [blame^]

571

},

572

"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.

573

"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}`.

574

"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`.

575

"a_key": "", # Properties of the object. Contains field @type with type URL.

576

},

577

"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.

578

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2020-07-22 17:02:09 -0700

[diff] [blame]

579

},

Bu Sun Kim