Blame - docs/dyn/compute_alpha.licenseCodes.html - platform/external/python/google-api-python-client

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

[diff] [blame]

80

Dan O'Meara

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

[diff] [blame]

81

<code><a href="#getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</a></code></p>

82

<p class="firstline">Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

83

Dan O'Meara

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

[diff] [blame]

84

<code><a href="#setIamPolicy">setIamPolicy(project, resource, body=None)</a></code></p>

85

<p class="firstline">Sets the access control policy on the specified resource. Replaces any existing policy. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

86

Dan O'Meara

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

[diff] [blame]

87

<code><a href="#testIamPermissions">testIamPermissions(project, resource, body=None)</a></code></p>

88

<p class="firstline">Returns permissions that a caller has on the specified resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.</p>

Bu Sun Kim

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

[diff] [blame]

89

<h3>Method Details</h3>

90

91

<code class="details" id="get">get(project, licenseCode)</code>

Dan O'Meara

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

[diff] [blame]

92

<pre>Return a specified license code. License codes are mirrored across all projects that have permissions to read the License Code. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

93

94

Args:

95

project: string, Project ID for this request. (required)

96

licenseCode: string, Number corresponding to the License code resource to return. (required)

97

98

Returns:

99

An object of the form:

100

Dan O'Meara

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

[diff] [blame]

101

{ # Represents a License Code resource.

102

#

103

# A License Code is a unique identifier used to represent a license resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images. (== resource_for {$api_version}.licenseCodes ==)

Bu Sun Kim

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

[diff] [blame^]

104

"creationTimestamp": "A String", # [Output Only] Creation timestamp in RFC3339 text format.

105

"description": "A String", # [Output Only] Description of this License Code.

106

"id": "A String", # [Output Only] The unique identifier for the resource. This identifier is defined by the server.

107

"kind": "compute#licenseCode", # [Output Only] Type of resource. Always compute#licenseCode for licenses.

108

"licenseAlias": [ # [Output Only] URL and description aliases of Licenses with the same License Code.

Bu Sun Kim

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

[diff] [blame]

109

{

Bu Sun Kim

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

[diff] [blame^]

110

"description": "A String", # [Output Only] Description of this License Code.

111

"selfLink": "A String", # [Output Only] URL of license corresponding to this License Code.

Bu Sun Kim

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

[diff] [blame]

112

},

113

],

Bu Sun Kim

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

[diff] [blame^]

114

"name": "A String", # [Output Only] Name of the resource. The name is 1-20 characters long and must be a valid 64 bit integer.

115

"selfLink": "A String", # [Output Only] Server-defined URL for the resource.

116

"state": "A String", # [Output Only] Current state of this License Code.

117

"transferable": True or False, # [Output Only] If true, the license will remain attached when creating images or snapshots from disks. Otherwise, the license is not transferred.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

122

<code class="details" id="getIamPolicy">getIamPolicy(project, resource, optionsRequestedPolicyVersion=None)</code>

123

<pre>Gets the access control policy for a resource. May be empty if no such policy or resource exists. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

124

125

Args:

126

project: string, Project ID for this request. (required)

127

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

128

optionsRequestedPolicyVersion: integer, Requested IAM Policy version.

Bu Sun Kim

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

[diff] [blame]

129

130

Returns:

131

An object of the form:

132

Dan O'Meara

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

[diff] [blame]

133

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

134

#

135

#

136

#

Dan O'Meara

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

[diff] [blame]

137

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

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

[diff] [blame]

138

#

Bu Sun Kim

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

[diff] [blame^]

139

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

140

#

Dan O'Meara

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

[diff] [blame]

141

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

142

#

Bu Sun Kim

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

[diff] [blame^]

143

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

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

[diff] [blame]

144

#

Dan O'Meara

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

[diff] [blame]

145

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

146

#

Bu Sun Kim

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

[diff] [blame^]

147

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

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

[diff] [blame]

148

#

Dan O'Meara

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

[diff] [blame]

149

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

150

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

151

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

152

#

153

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

154

#

155

# Example Policy with multiple AuditConfigs:

156

#

Bu Sun Kim

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

[diff] [blame^]

157

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

158

#

Dan O'Meara

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

[diff] [blame]

159

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame^]

160

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

161

{ # Provides the configuration for logging a type of permissions. Example:

162

#

Bu Sun Kim

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

[diff] [blame^]

163

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

164

#

Bu Sun Kim

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

[diff] [blame^]

165

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

166

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

167

"A String",

Bu Sun Kim

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

[diff] [blame]

168

],

Bu Sun Kim

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

[diff] [blame^]

169

"ignoreChildExemptions": True or False,

170

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

171

},

172

],

Bu Sun Kim

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

[diff] [blame^]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

177

},

178

],

Bu Sun Kim

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

[diff] [blame^]

179

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

180

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame^]

181

"condition": { # 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. # The condition that is associated with this binding.

182

#

183

# If the condition evaluates to `true`, then this binding applies to the current request.

184

#

185

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

186

#

187

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

188

#

189

# Example (Comparison):

190

#

191

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

192

#

193

# Example (Equality):

194

#

195

# 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'"

200

#

201

# Example (Data Manipulation):

202

#

203

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

204

#

205

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

206

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

207

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

208

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

209

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

210

},

211

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

212

#

213

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

214

#

215

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

216

#

Dan O'Meara

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

[diff] [blame]

217

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

222

#

223

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

224

#

Dan O'Meara

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

[diff] [blame]

225

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

226

#

227

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

228

#

229

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

230

#

Bu Sun Kim

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

[diff] [blame]

231

#

232

#

233

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame^]

234

"A String",

Bu Sun Kim

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

[diff] [blame]

235

],

Bu Sun Kim

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

[diff] [blame^]

236

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

237

},

238

],

Bu Sun Kim

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

[diff] [blame^]

239

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

240

#

241

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

242

"iamOwned": True or False,

243

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

244

{ # A rule to be applied in a Policy.

245

"action": "A String", # Required

246

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

247

{ # A condition to be met.

248

"iam": "A String", # Trusted attributes supplied by the IAM system.

249

"op": "A String", # An operator to apply the subject with.

250

"svc": "A String", # Trusted attributes discharged by the service.

251

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

252

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

258

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

259

"A String",

260

],

261

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

262

{ # Specifies what kind of log the caller must write

263

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

264

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

265

"permissionType": "A String", # The type of the permission that was checked.

266

},

267

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

268

},

269

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

270

#

271

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

272

#

273

# Field names correspond to IAM request parameters and field values are their respective values.

274

#

275

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

276

#

277

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

278

"customFields": [ # Custom fields.

279

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

280

"name": "A String", # Name is the field name.

281

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

282

},

283

],

284

"field": "A String", # The field value to attribute.

285

"metric": "A String", # The metric to update.

286

},

287

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

288

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

293

"A String",

294

],

295

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

301

#

302

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

303

#

304

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

305

#

306

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

307

#

308

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

309

#

310

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

311

#

312

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

317

<code class="details" id="setIamPolicy">setIamPolicy(project, resource, body=None)</code>

318

<pre>Sets the access control policy on the specified resource. Replaces any existing policy. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim

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

[diff] [blame]

319

320

Args:

321

project: string, Project ID for this request. (required)

322

resource: string, Name or id of the resource for this request. (required)

Dan O'Meara

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

[diff] [blame]

323

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

324

The object takes the form of:

325

326

{

Bu Sun Kim

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

[diff] [blame^]

327

"bindings": [ # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify bindings.

328

{ # Associates `members` with a `role`.

329

"condition": { # 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. # The condition that is associated with this binding.

330

#

331

# If the condition evaluates to `true`, then this binding applies to the current request.

332

#

333

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

334

#

335

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

336

#

337

# Example (Comparison):

338

#

339

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

340

#

341

# Example (Equality):

342

#

343

# 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'"

348

#

349

# Example (Data Manipulation):

350

#

351

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

352

#

353

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

354

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

355

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

356

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

357

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

358

},

359

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

360

#

361

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

362

#

363

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

364

#

365

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

370

#

371

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

372

#

373

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

374

#

375

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

376

#

377

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

#

#

#

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

382

"A String",

383

],

384

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

385

},

386

],

387

"etag": "A String", # Flatten Policy to create a backward compatible wire-format. Deprecated. Use 'policy' to specify the etag.

388

"policy": { # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources. # REQUIRED: The complete policy to be applied to the 'resource'. The size of the policy is limited to a few 10s of KB. An empty policy is in general a valid policy but certain services (like Projects) might reject them.

Bu Sun Kim

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

[diff] [blame]

389

#

390

#

391

#

Dan O'Meara

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

[diff] [blame]

392

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

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

[diff] [blame]

393

#

Bu Sun Kim

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

[diff] [blame^]

394

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

395

#

Dan O'Meara

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

[diff] [blame]

396

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

397

#

Bu Sun Kim

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

[diff] [blame^]

398

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

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

[diff] [blame]

399

#

Dan O'Meara

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

[diff] [blame]

400

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

401

#

Bu Sun Kim

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

[diff] [blame^]

402

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

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

[diff] [blame]

403

#

Dan O'Meara

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

[diff] [blame]

404

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

405

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

406

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

407

#

408

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

409

#

410

# Example Policy with multiple AuditConfigs:

411

#

Bu Sun Kim

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

[diff] [blame^]

412

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

413

#

Dan O'Meara

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

[diff] [blame]

414

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame^]

415

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

416

{ # Provides the configuration for logging a type of permissions. Example:

417

#

Bu Sun Kim

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

[diff] [blame^]

418

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

419

#

Bu Sun Kim

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

[diff] [blame^]

420

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

421

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

422

"A String",

Bu Sun Kim

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

[diff] [blame]

423

],

Bu Sun Kim

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

[diff] [blame^]

424

"ignoreChildExemptions": True or False,

425

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

426

},

427

],

Bu Sun Kim

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

[diff] [blame^]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

432

},

433

],

Bu Sun Kim

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

[diff] [blame^]

434

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

435

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame^]

436

"condition": { # 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. # The condition that is associated with this binding.

437

#

438

# If the condition evaluates to `true`, then this binding applies to the current request.

439

#

440

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

441

#

442

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

443

#

444

# Example (Comparison):

445

#

446

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

447

#

448

# Example (Equality):

449

#

450

# 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'"

455

#

456

# Example (Data Manipulation):

457

#

458

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

459

#

460

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

461

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

462

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

463

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

464

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

465

},

466

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

467

#

468

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

469

#

470

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

471

#

Dan O'Meara

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

[diff] [blame]

472

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

477

#

478

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

479

#

Dan O'Meara

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

[diff] [blame]

480

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

481

#

482

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

483

#

484

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

485

#

Bu Sun Kim

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

[diff] [blame]

486

#

487

#

488

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame^]

489

"A String",

Bu Sun Kim

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

[diff] [blame]

490

],

Bu Sun Kim

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

[diff] [blame^]

491

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

492

},

493

],

Bu Sun Kim

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

[diff] [blame^]

494

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

495

#

496

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

497

"iamOwned": True or False,

498

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

499

{ # A rule to be applied in a Policy.

500

"action": "A String", # Required

501

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

502

{ # A condition to be met.

503

"iam": "A String", # Trusted attributes supplied by the IAM system.

504

"op": "A String", # An operator to apply the subject with.

505

"svc": "A String", # Trusted attributes discharged by the service.

506

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

507

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

513

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

514

"A String",

515

],

516

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

517

{ # Specifies what kind of log the caller must write

518

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

519

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

520

"permissionType": "A String", # The type of the permission that was checked.

521

},

522

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

523

},

524

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

525

#

526

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

527

#

528

# Field names correspond to IAM request parameters and field values are their respective values.

529

#

530

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

531

#

532

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

533

"customFields": [ # Custom fields.

534

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

535

"name": "A String", # Name is the field name.

536

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

537

},

538

],

539

"field": "A String", # The field value to attribute.

540

"metric": "A String", # The metric to update.

541

},

542

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

543

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

548

"A String",

549

],

550

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

551

"A String",

552

],

Bu Sun Kim

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

[diff] [blame]

553

},

Bu Sun Kim

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

[diff] [blame^]

554

],

555

"version": 42, # Specifies the format of the policy.

556

#

557

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

558

#

559

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

560

#

561

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

562

#

563

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

564

#

565

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

566

#

567

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

568

},

Bu Sun Kim

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

[diff] [blame]

}

Returns:

An object of the form:

574

Dan O'Meara

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

[diff] [blame]

575

{ # An Identity and Access Management (IAM) policy, which specifies access controls for Google Cloud resources.

Bu Sun Kim

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

[diff] [blame]

576

#

577

#

578

#

Dan O'Meara

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

[diff] [blame]

579

# A `Policy` is a collection of `bindings`. A `binding` binds one or more `members` to a single `role`. Members can be user accounts, service accounts, Google groups, and domains (such as G Suite). A `role` is a named list of permissions; each `role` can be an IAM predefined role or a user-created custom role.

Bu Sun Kim

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

[diff] [blame]

580

#

Bu Sun Kim

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

[diff] [blame^]

581

# For some types of Google Cloud resources, a `binding` can also specify a `condition`, which is a logical expression that allows access to a resource only if the expression evaluates to `true`. A condition can add constraints based on attributes of the request, the resource, or both. To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

582

#

Dan O'Meara

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

[diff] [blame]

583

# **JSON example:**

Bu Sun Kim

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

[diff] [blame]

584

#

Bu Sun Kim

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

[diff] [blame^]

585

# { "bindings": [ { "role": "roles/resourcemanager.organizationAdmin", "members": [ "user:mike@example.com", "group:admins@example.com", "domain:google.com", "serviceAccount:my-project-id@appspot.gserviceaccount.com" ] }, { "role": "roles/resourcemanager.organizationViewer", "members": [ "user:eve@example.com" ], "condition": { "title": "expirable access", "description": "Does not grant access after Sep 2020", "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')", } } ], "etag": "BwWWja0YfJA=", "version": 3 }

Bu Sun Kim

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

[diff] [blame]

586

#

Dan O'Meara

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

[diff] [blame]

587

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

588

#

Bu Sun Kim

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

[diff] [blame^]

589

# bindings: - members: - user:mike@example.com - group:admins@example.com - domain:google.com - serviceAccount:my-project-id@appspot.gserviceaccount.com role: roles/resourcemanager.organizationAdmin - members: - user:eve@example.com role: roles/resourcemanager.organizationViewer condition: title: expirable access description: Does not grant access after Sep 2020 expression: request.time < timestamp('2020-10-01T00:00:00.000Z') - etag: BwWWja0YfJA= - version: 3

Bu Sun Kim

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

[diff] [blame]

590

#

Dan O'Meara

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

[diff] [blame]

591

# For a description of IAM and its features, see the [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame^]

592

"auditConfigs": [ # Specifies cloud audit logging configuration for this policy.

Bu Sun Kim

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

[diff] [blame]

593

{ # Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs.

594

#

595

# If there are AuditConfigs for both `allServices` and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted.

596

#

597

# Example Policy with multiple AuditConfigs:

598

#

Bu Sun Kim

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

[diff] [blame^]

599

# { "audit_configs": [ { "service": "allServices" "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", }, { "log_type": "ADMIN_READ", } ] }, { "service": "sampleservice.googleapis.com" "audit_log_configs": [ { "log_type": "DATA_READ", }, { "log_type": "DATA_WRITE", "exempted_members": [ "user:aliya@example.com" ] } ] } ] }

Bu Sun Kim

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

[diff] [blame]

600

#

Dan O'Meara

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

[diff] [blame]

601

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.

Bu Sun Kim

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

[diff] [blame^]

602

"auditLogConfigs": [ # The configuration for logging of each type of permission.

Bu Sun Kim

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

[diff] [blame]

603

{ # Provides the configuration for logging a type of permissions. Example:

604

#

Bu Sun Kim

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

[diff] [blame^]

605

# { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": [ "user:jose@example.com" ] }, { "log_type": "DATA_WRITE", } ] }

Bu Sun Kim

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

[diff] [blame]

606

#

Bu Sun Kim

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

[diff] [blame^]

607

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.

608

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of permission. Follows the same format of [Binding.members][].

609

"A String",

Bu Sun Kim

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

[diff] [blame]

610

],

Bu Sun Kim

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

[diff] [blame^]

611

"ignoreChildExemptions": True or False,

612

"logType": "A String", # The log type that this config enables.

Bu Sun Kim

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

[diff] [blame]

613

},

614

],

Bu Sun Kim

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

[diff] [blame^]

"exemptedMembers": [

"A String",

],

"service": "A String", # Specifies a service that will be enabled for audit logging. For example, `storage.googleapis.com`, `cloudsql.googleapis.com`. `allServices` is a special value that covers all services.

Bu Sun Kim

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

[diff] [blame]

619

},

620

],

Bu Sun Kim

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

[diff] [blame^]

621

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a `condition` that determines how and when the `bindings` are applied. Each of the `bindings` must contain at least one member.

Bu Sun Kim

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

[diff] [blame]

622

{ # Associates `members` with a `role`.

Bu Sun Kim

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

[diff] [blame^]

623

"condition": { # 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. # The condition that is associated with this binding.

624

#

625

# If the condition evaluates to `true`, then this binding applies to the current request.

626

#

627

# If the condition evaluates to `false`, then this binding does not apply to the current request. However, a different role binding might grant the same role to one or more of the members in this binding.

628

#

629

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

630

#

631

# Example (Comparison):

632

#

633

# title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100"

634

#

635

# Example (Equality):

636

#

637

# 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'"

642

#

643

# Example (Data Manipulation):

644

#

645

# title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)"

646

#

647

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

648

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

649

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

650

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

651

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

652

},

653

"members": [ # Specifies the identities requesting access for a Cloud Platform resource. `members` can have the following values:

Bu Sun Kim

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

[diff] [blame]

654

#

655

# * `allUsers`: A special identifier that represents anyone who is on the internet; with or without a Google account.

656

#

657

# * `allAuthenticatedUsers`: A special identifier that represents anyone who is authenticated with a Google account or a service account.

658

#

Dan O'Meara

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

[diff] [blame]

659

# * `user:{emailid}`: An email address that represents a specific Google account. For example, `alice@example.com` .

Bu Sun Kim

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

[diff] [blame]

#

#

#

# * `serviceAccount:{emailid}`: An email address that represents a service account. For example, `my-other-app@appspot.gserviceaccount.com`.

664

#

665

# * `group:{emailid}`: An email address that represents a Google group. For example, `admins@example.com`.

666

#

Dan O'Meara

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

[diff] [blame]

667

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a user that has been recently deleted. For example, `alice@example.com?uid=123456789012345678901`. If the user is recovered, this value reverts to `user:{emailid}` and the recovered user retains the role in the binding.

668

#

669

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a service account that has been recently deleted. For example, `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`. If the service account is undeleted, this value reverts to `serviceAccount:{emailid}` and the undeleted service account retains the role in the binding.

670

#

671

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique identifier) representing a Google group that has been recently deleted. For example, `admins@example.com?uid=123456789012345678901`. If the group is recovered, this value reverts to `group:{emailid}` and the recovered group retains the role in the binding.

672

#

Bu Sun Kim

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

[diff] [blame]

673

#

674

#

675

# * `domain:{domain}`: The G Suite domain (primary) that represents all the users of that domain. For example, `google.com` or `example.com`.

Bu Sun Kim

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

[diff] [blame^]

676

"A String",

Bu Sun Kim

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

[diff] [blame]

677

],

Bu Sun Kim

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

[diff] [blame^]

678

"role": "A String", # Role that is assigned to `members`. For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

679

},

680

],

Bu Sun Kim

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

[diff] [blame^]

681

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help prevent simultaneous updates of a policy from overwriting each other. It is strongly suggested that systems make use of the `etag` in the read-modify-write cycle to perform policy updates in order to avoid race conditions: An `etag` is returned in the response to `getIamPolicy`, and systems are expected to put that etag in the request to `setIamPolicy` to ensure that their change will be applied to the same version of the policy.

682

#

683

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

684

"iamOwned": True or False,

685

"rules": [ # If more than one rule is specified, the rules are applied in the following manner: - All matching LOG rules are always applied. - If any DENY/DENY_WITH_LOG rule matches, permission is denied. Logging will be applied if one or more matching rule requires logging. - Otherwise, if any ALLOW/ALLOW_WITH_LOG rule matches, permission is granted. Logging will be applied if one or more matching rule requires logging. - Otherwise, if no rule applies, permission is denied.

686

{ # A rule to be applied in a Policy.

687

"action": "A String", # Required

688

"conditions": [ # Additional restrictions that must be met. All conditions must pass for the rule to match.

689

{ # A condition to be met.

690

"iam": "A String", # Trusted attributes supplied by the IAM system.

691

"op": "A String", # An operator to apply the subject with.

692

"svc": "A String", # Trusted attributes discharged by the service.

693

"sys": "A String", # Trusted attributes supplied by any service that owns resources and uses the IAM system for access control.

694

"values": [ # The objects of the condition.

"A String",

],

},

],

"description": "A String", # Human-readable description of the rule.

700

"ins": [ # If one or more 'in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in at least one of these entries.

701

"A String",

702

],

703

"logConfigs": [ # The config returned to callers of tech.iam.IAM.CheckPolicy for any entries that match the LOG action.

704

{ # Specifies what kind of log the caller must write

705

"cloudAudit": { # Write a Cloud Audit log # Cloud audit options.

706

"authorizationLoggingOptions": { # Authorization-related information used by Cloud Audit Logging. # Information used by the Cloud Audit Logging pipeline.

707

"permissionType": "A String", # The type of the permission that was checked.

708

},

709

"logName": "A String", # The log_name to populate in the Cloud Audit Record.

710

},

711

"counter": { # Increment a streamz counter with the specified metric and field names. # Counter options.

712

#

713

# Metric names should start with a '/', generally be lowercase-only, and end in "_count". Field names should not contain an initial slash. The actual exported metric names will have "/iam/policy" prepended.

714

#

715

# Field names correspond to IAM request parameters and field values are their respective values.

716

#

717

# Supported field names: - "authority", which is "[token]" if IAMContext.token is present, otherwise the value of IAMContext.authority_selector if present, and otherwise a representation of IAMContext.principal; or - "iam_principal", a representation of IAMContext.principal even if a token or authority selector is present; or - "" (empty string), resulting in a counter with no fields.

718

#

719

# Examples: counter { metric: "/debug_access_count" field: "iam_principal" } ==> increment counter /iam/policy/debug_access_count {iam_principal=[value of IAMContext.principal]}

720

"customFields": [ # Custom fields.

721

{ # Custom fields. These can be used to create a counter with arbitrary field/value pairs. See: go/rpcsp-custom-fields.

722

"name": "A String", # Name is the field name.

723

"value": "A String", # Value is the field value. It is important that in contrast to the CounterOptions.field, the value here is a constant that is not derived from the IAMContext.

724

},

725

],

726

"field": "A String", # The field value to attribute.

727

"metric": "A String", # The metric to update.

728

},

729

"dataAccess": { # Write a Data Access (Gin) log # Data access options.

730

"logMode": "A String",

},

},

],

"notIns": [ # If one or more 'not_in' clauses are specified, the rule matches if the PRINCIPAL/AUTHORITY_SELECTOR is in none of the entries.

735

"A String",

736

],

737

"permissions": [ # A permission is a string of form '..' (e.g., 'storage.buckets.list'). A value of '*' matches all permissions, and a verb part of '*' (e.g., 'storage.buckets.*') matches all verbs.

"A String",

],

},

],

"version": 42, # Specifies the format of the policy.

743

#

744

# Valid values are `0`, `1`, and `3`. Requests that specify an invalid value are rejected.

745

#

746

# Any operation that affects conditional role bindings must specify version `3`. This requirement applies to the following operations:

747

#

748

# * Getting a policy that includes a conditional role binding * Adding a conditional role binding to a policy * Changing a conditional role binding in a policy * Removing any role binding, with or without a condition, from a policy that includes conditions

749

#

750

# **Important:** If you use IAM Conditions, you must include the `etag` field whenever you call `setIamPolicy`. If you omit this field, then IAM allows you to overwrite a version `3` policy with a version `1` policy, and all of the conditions in the version `3` policy are lost.

751

#

752

# If a policy does not include any conditions, operations on that policy may specify any valid version or leave the field unset.

753

#

754

# To learn which resources support conditions in their IAM policies, see the [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

759

<code class="details" id="testIamPermissions">testIamPermissions(project, resource, body=None)</code>

760

<pre>Returns permissions that a caller has on the specified resource. Caution This resource is intended for use only by third-party partners who are creating Cloud Marketplace images.

Bu Sun Kim