Blame - docs/dyn/cloudresourcemanager_v1beta1.projects.html - platform/external/python/google-api-python-client

2015-06-15 16:44:50 +0000

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Dan O'Meara

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

[diff] [blame]

78

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

79

<p class="firstline">Creates a Project resource.</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

80

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

81

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

82

<p class="firstline">Marks the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

83

Thomas Coffee

2f24537

2017-03-27 10:39:26 -0700

[diff] [blame]

84

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

85

<p class="firstline">Retrieves the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

86

Bu Sun Kim

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

[diff] [blame]

87

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

88

<p class="firstline">Gets a list of ancestors in the resource hierarchy for the Project</p>

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

89

Bu Sun Kim

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

[diff] [blame]

90

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

91

<p class="firstline">Returns the IAM access control policy for the specified Project.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

92

Bu Sun Kim

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

[diff] [blame]

93

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

Bu Sun Kim

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

[diff] [blame]

94

<p class="firstline">Lists Projects that the caller has the `resourcemanager.projects.get`</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

95

96

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

97

<p class="firstline">Retrieves the next page of results.</p>

98

Dan O'Meara

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

[diff] [blame]

99

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

Bu Sun Kim

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

[diff] [blame]

100

<p class="firstline">Sets the IAM access control policy for the specified Project. Overwrites</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

101

Dan O'Meara

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

[diff] [blame]

102

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

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

103

<p class="firstline">Returns permissions that a caller has on the specified Project.</p>

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

104

Bu Sun Kim

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

[diff] [blame]

105

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

106

<p class="firstline">Restores the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

107

Dan O'Meara

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

[diff] [blame]

108

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

109

<p class="firstline">Updates the attributes of the Project identified by the specified</p>

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

110

<h3>Method Details</h3>

111

Dan O'Meara

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

[diff] [blame]

112

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

113

<pre>Creates a Project resource.

114

115

Initially, the Project resource is owned by its creator exclusively.

116

The creator can later grant permission to others to read or update the

117

Project.

118

119

Several APIs are activated automatically for the Project, including

Bu Sun Kim

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

[diff] [blame]

120

Google Cloud Storage. The parent is identified by a specified

121

ResourceId, which must include both an ID and a type, such as

122

project, folder, or organization.

123

124

This method does not associate the new project with a billing account.

125

You can set or update the billing account associated with a project using

126

the [`projects.updateBillingInfo`]

127

(/billing/reference/rest/v1/projects/updateBillingInfo) method.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

128

129

Args:

Dan O'Meara

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

[diff] [blame]

130

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

131

The object takes the form of:

132

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

133

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

134

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

135

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

136

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

137

#

Bu Sun Kim

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

[diff] [blame]

138

# Read-only.

139

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

140

#

Bu Sun Kim

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

[diff] [blame]

141

# Example: <code>415104041262</code>

142

# Read-only.

143

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

144

#

145

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

146

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

147

# `UpdateProject` method; the end user must have the

148

# `resourcemanager.projects.create` permission on the parent.

149

#

150

# Read-write.

151

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

152

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

153

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

154

"type": "A String", # Required field representing the resource type this id is for.

155

# At present, the valid types are "project", "folder", and "organization".

156

"id": "A String", # Required field for the type-specific id. This should correspond to the id

157

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

158

},

Bu Sun Kim

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

[diff] [blame]

159

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

160

#

161

# Label keys must be between 1 and 63 characters long and must conform

162

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

163

#

164

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

165

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

166

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

167

#

168

# No more than 256 labels can be associated with a given resource.

169

#

170

# Clients should store labels in a representation such as JSON that does not

171

# depend on specific characters being disallowed.

172

#

Bu Sun Kim

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

[diff] [blame]

173

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

174

# Read-write.

Bu Sun Kim

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

[diff] [blame]

175

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

176

},

Bu Sun Kim

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

[diff] [blame]

177

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

178

#

179

# Read-only.

Bu Sun Kim

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

[diff] [blame]

180

"name": "A String", # The optional user-assigned display name of the Project.

181

# When present it must be between 4 to 30 characters.

182

# Allowed characters are: lowercase and uppercase letters, numbers,

183

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

184

#

Bu Sun Kim

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

[diff] [blame]

185

# Example: <code>My Project</code>

186

# Read-write.

187

"projectId": "A String", # The unique, user-assigned ID of the Project.

188

# It must be 6 to 30 lowercase letters, digits, or hyphens.

189

# It must start with a letter.

190

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

191

#

Bu Sun Kim

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

[diff] [blame]

192

# Example: <code>tokyo-rain-123</code>

193

# Read-only after creation.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

194

}

195

Dan O'Meara

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

[diff] [blame]

196

useLegacyStack: boolean, A now unused experiment opt-out option.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

197

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

198

Allowed values

199

1 - v1 error format

200

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

201

202

Returns:

203

An object of the form:

204

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

205

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

206

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

207

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

208

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

209

#

Bu Sun Kim

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

[diff] [blame]

210

# Read-only.

211

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

212

#

Bu Sun Kim

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

[diff] [blame]

213

# Example: <code>415104041262</code>

214

# Read-only.

215

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

216

#

217

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

218

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

219

# `UpdateProject` method; the end user must have the

220

# `resourcemanager.projects.create` permission on the parent.

221

#

222

# Read-write.

223

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

224

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

225

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

226

"type": "A String", # Required field representing the resource type this id is for.

227

# At present, the valid types are "project", "folder", and "organization".

228

"id": "A String", # Required field for the type-specific id. This should correspond to the id

229

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

230

},

Bu Sun Kim

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

[diff] [blame]

231

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

232

#

233

# Label keys must be between 1 and 63 characters long and must conform

234

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

235

#

236

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

237

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

238

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

239

#

240

# No more than 256 labels can be associated with a given resource.

241

#

242

# Clients should store labels in a representation such as JSON that does not

243

# depend on specific characters being disallowed.

244

#

Bu Sun Kim

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

[diff] [blame]

245

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

246

# Read-write.

Bu Sun Kim

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

[diff] [blame]

247

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

248

},

Bu Sun Kim

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

[diff] [blame]

249

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

250

#

251

# Read-only.

Bu Sun Kim

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

[diff] [blame]

252

"name": "A String", # The optional user-assigned display name of the Project.

253

# When present it must be between 4 to 30 characters.

254

# Allowed characters are: lowercase and uppercase letters, numbers,

255

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

256

#

Bu Sun Kim

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

[diff] [blame]

257

# Example: <code>My Project</code>

258

# Read-write.

259

"projectId": "A String", # The unique, user-assigned ID of the Project.

260

# It must be 6 to 30 lowercase letters, digits, or hyphens.

261

# It must start with a letter.

262

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

263

#

Bu Sun Kim

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

[diff] [blame]

264

# Example: <code>tokyo-rain-123</code>

265

# Read-only after creation.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

270

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

271

<pre>Marks the Project identified by the specified

272

`project_id` (for example, `my-project-123`) for deletion.

Bu Sun Kim

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

[diff] [blame]

273

This method will only affect the Project if it has a lifecycle state of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

274

ACTIVE.

275

Bu Sun Kim

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

[diff] [blame]

276

This method changes the Project's lifecycle state from

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

277

ACTIVE

278

to DELETE_REQUESTED.

279

The deletion starts at an unspecified time, at which point the project is

280

no longer accessible.

281

282

Until the deletion completes, you can check the lifecycle state

283

checked by retrieving the Project with GetProject,

284

and the Project remains visible to ListProjects.

285

However, you cannot update the project.

286

287

After the deletion completes, the Project is not retrievable by

Bu Sun Kim

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

[diff] [blame]

288

the GetProject

289

and ListProjects

290

methods.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

291

292

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

293

294

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

295

projectId: string, The Project ID (for example, `foo-bar-123`).

296

297

Required. (required)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

298

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

299

Allowed values

300

1 - v1 error format

301

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

302

303

Returns:

304

An object of the form:

305

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

306

{ # A generic empty message that you can re-use to avoid defining duplicated

307

# empty messages in your APIs. A typical example is to use it as the request

308

# or the response type of an API method. For instance:

309

#

310

# service Foo {

311

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

312

# }

313

#

314

# The JSON representation for `Empty` is empty JSON object `{}`.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Thomas Coffee

2017-03-27 10:39:26 -0700

[diff] [blame]

319

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

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

320

<pre>Retrieves the Project identified by the specified

321

`project_id` (for example, `my-project-123`).

322

323

The caller must have read permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

324

325

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

326

projectId: string, The Project ID (for example, `my-project-123`).

327

328

Required. (required)

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

329

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

330

Allowed values

331

1 - v1 error format

332

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

333

334

Returns:

335

An object of the form:

336

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

337

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

338

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

339

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

340

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

341

#

Bu Sun Kim

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

[diff] [blame]

342

# Read-only.

343

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

344

#

Bu Sun Kim

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

[diff] [blame]

345

# Example: <code>415104041262</code>

346

# Read-only.

347

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

348

#

349

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

350

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

351

# `UpdateProject` method; the end user must have the

352

# `resourcemanager.projects.create` permission on the parent.

353

#

354

# Read-write.

355

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

356

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

357

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

358

"type": "A String", # Required field representing the resource type this id is for.

359

# At present, the valid types are "project", "folder", and "organization".

360

"id": "A String", # Required field for the type-specific id. This should correspond to the id

361

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

362

},

Bu Sun Kim

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

[diff] [blame]

363

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

364

#

365

# Label keys must be between 1 and 63 characters long and must conform

366

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

367

#

368

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

369

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

370

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

371

#

372

# No more than 256 labels can be associated with a given resource.

373

#

374

# Clients should store labels in a representation such as JSON that does not

375

# depend on specific characters being disallowed.

376

#

Bu Sun Kim

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

[diff] [blame]

377

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

378

# Read-write.

Bu Sun Kim

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

[diff] [blame]

379

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

380

},

Bu Sun Kim

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

[diff] [blame]

381

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

382

#

383

# Read-only.

Bu Sun Kim

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

[diff] [blame]

384

"name": "A String", # The optional user-assigned display name of the Project.

385

# When present it must be between 4 to 30 characters.

386

# Allowed characters are: lowercase and uppercase letters, numbers,

387

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

388

#

Bu Sun Kim

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

[diff] [blame]

389

# Example: <code>My Project</code>

390

# Read-write.

391

"projectId": "A String", # The unique, user-assigned ID of the Project.

392

# It must be 6 to 30 lowercase letters, digits, or hyphens.

393

# It must start with a letter.

394

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

395

#

Bu Sun Kim

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

[diff] [blame]

396

# Example: <code>tokyo-rain-123</code>

397

# Read-only after creation.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

402

<code class="details" id="getAncestry">getAncestry(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

403

<pre>Gets a list of ancestors in the resource hierarchy for the Project

404

identified by the specified `project_id` (for example, `my-project-123`).

405

406

The caller must have read permissions for this Project.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

407

408

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

409

projectId: string, The Project ID (for example, `my-project-123`).

410

411

Required. (required)

Bu Sun Kim

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

[diff] [blame]

412

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

413

The object takes the form of:

414

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

415

{ # The request sent to the

416

# GetAncestry

417

# method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

418

}

419

420

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

421

Allowed values

422

1 - v1 error format

423

2 - v2 error format

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

424

425

Returns:

426

An object of the form:

427

428

{ # Response from the GetAncestry method.

Bu Sun Kim

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

[diff] [blame]

429

"ancestor": [ # Ancestors are ordered from bottom to top of the resource hierarchy. The

430

# first ancestor is the project itself, followed by the project's parent,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

431

# etc.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

432

{ # Identifying information for a single ancestor of a project.

Bu Sun Kim

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

[diff] [blame]

433

"resourceId": { # A container to reference an id for any resource type. A `resource` in Google # Resource id of the ancestor.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

434

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

435

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

436

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

437

"type": "A String", # Required field representing the resource type this id is for.

438

# At present, the valid types are "project", "folder", and "organization".

439

"id": "A String", # Required field for the type-specific id. This should correspond to the id

440

# used in the type-specific API's.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

},

},

],

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

448

<code class="details" id="getIamPolicy">getIamPolicy(resource, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

449

<pre>Returns the IAM access control policy for the specified Project.

450

Permission is denied if the policy or the resource does not exist.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

451

Bu Sun Kim

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

[diff] [blame]

452

For additional information about resource structure and identification,

453

see [Resource Names](/apis/design/resource_names).

454

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

455

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

456

resource: string, REQUIRED: The resource for which the policy is being requested.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

457

See the operation documentation for the appropriate value for this field. (required)

Bu Sun Kim

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

[diff] [blame]

458

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

459

The object takes the form of:

460

461

{ # Request message for `GetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

462

"options": { # Encapsulates settings provided to GetIamPolicy. # OPTIONAL: A `GetPolicyOptions` object for specifying options to

Dan O'Meara

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

[diff] [blame]

463

# `GetIamPolicy`.

Bu Sun Kim

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

[diff] [blame]

464

"requestedPolicyVersion": 42, # Optional. The policy format version to be returned.

Dan O'Meara

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

[diff] [blame]

465

#

466

# Valid values are 0, 1, and 3. Requests specifying an invalid value will be

467

# rejected.

468

#

469

# Requests for policies with any conditional bindings must specify version 3.

470

# Policies without any conditional bindings may specify any valid value or

471

# leave the field unset.

Bu Sun Kim

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

[diff] [blame]

472

#

473

# To learn which resources support conditions in their IAM policies, see the

474

# [IAM

475

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

476

},

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

477

}

478

479

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

480

Allowed values

481

1 - v1 error format

482

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

483

484

Returns:

485

An object of the form:

486

Dan O'Meara

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

[diff] [blame]

487

{ # An Identity and Access Management (IAM) policy, which specifies access

488

# controls for Google Cloud resources.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

489

#

490

#

Dan O'Meara

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

[diff] [blame]

491

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

492

# `members` to a single `role`. Members can be user accounts, service accounts,

493

# Google groups, and domains (such as G Suite). A `role` is a named list of

494

# permissions; each `role` can be an IAM predefined role or a user-created

495

# custom role.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

496

#

Bu Sun Kim

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

[diff] [blame]

497

# For some types of Google Cloud resources, a `binding` can also specify a

498

# `condition`, which is a logical expression that allows access to a resource

499

# only if the expression evaluates to `true`. A condition can add constraints

500

# based on attributes of the request, the resource, or both. To learn which

501

# resources support conditions in their IAM policies, see the

502

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

503

#

504

# **JSON example:**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

505

#

506

# {

Bu Sun Kim

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

[diff] [blame]

507

# "bindings": [

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

508

# {

Bu Sun Kim

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

[diff] [blame]

509

# "role": "roles/resourcemanager.organizationAdmin",

510

# "members": [

511

# "user:mike@example.com",

512

# "group:admins@example.com",

513

# "domain:google.com",

514

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

515

# ]

516

# },

517

# {

Bu Sun Kim

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

[diff] [blame]

518

# "role": "roles/resourcemanager.organizationViewer",

519

# "members": [

520

# "user:eve@example.com"

521

# ],

522

# "condition": {

523

# "title": "expirable access",

524

# "description": "Does not grant access after Sep 2020",

525

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

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

[diff] [blame]

526

# }

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

527

# }

Dan O'Meara

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

[diff] [blame]

528

# ],

Bu Sun Kim

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

[diff] [blame]

529

# "etag": "BwWWja0YfJA=",

530

# "version": 3

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

531

# }

532

#

Dan O'Meara

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

[diff] [blame]

533

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

538

# - group:admins@example.com

539

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

540

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

541

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

542

# - members:

Dan O'Meara

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

[diff] [blame]

543

# - user:eve@example.com

544

# role: roles/resourcemanager.organizationViewer

545

# condition:

546

# title: expirable access

547

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

548

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

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

[diff] [blame]

549

# - etag: BwWWja0YfJA=

550

# - version: 3

Bu Sun Kim

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

[diff] [blame]

551

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

552

# For a description of IAM and its features, see the

Dan O'Meara

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

[diff] [blame]

553

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

554

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

555

{ # Specifies the audit configuration for a service.

556

# The configuration determines which permission types are logged, and what

557

# identities, if any, are exempted from logging.

558

# An AuditConfig must have one or more AuditLogConfigs.

559

#

560

# If there are AuditConfigs for both `allServices` and a specific service,

561

# the union of the two AuditConfigs is used for that service: the log_types

562

# specified in each AuditConfig are enabled, and the exempted_members in each

563

# AuditLogConfig are exempted.

564

#

565

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

571

# "audit_log_configs": [

572

# {

573

# "log_type": "DATA_READ",

574

# "exempted_members": [

575

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

580

# },

581

# {

582

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

588

# "audit_log_configs": [

589

# {

590

# "log_type": "DATA_READ",

591

# },

592

# {

593

# "log_type": "DATA_WRITE",

594

# "exempted_members": [

595

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

604

# logging. It also exempts jose@example.com from DATA_READ logging, and

605

# aliya@example.com from DATA_WRITE logging.

606

"service": "A String", # Specifies a service that will be enabled for audit logging.

607

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

608

# `allServices` is a special value that covers all services.

609

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

610

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

# Example:

#

# {

# "audit_log_configs": [

615

# {

616

# "log_type": "DATA_READ",

617

# "exempted_members": [

618

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

628

# jose@example.com from DATA_READ logging.

629

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

630

# permission.

631

# Follows the same format of Binding.members.

632

"A String",

633

],

634

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

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

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

[diff] [blame]

640

# `condition` that determines how and when the `bindings` are applied. Each

641

# of the `bindings` must contain at least one member.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

642

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

Bu Sun Kim

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

[diff] [blame]

643

"role": "A String", # Role that is assigned to `members`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

644

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

645

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

646

#

647

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

648

# current request.

649

#

650

# If the condition evaluates to `false`, then this binding does not apply to

651

# the current request. However, a different role binding might grant the same

652

# role to one or more of the members in this binding.

653

#

654

# To learn which resources support conditions in their IAM policies, see the

655

# [IAM

656

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

657

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

658

# are documented at https://github.com/google/cel-spec.

Bu Sun Kim

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

[diff] [blame]

659

#

Dan O'Meara

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

[diff] [blame]

660

# Example (Comparison):

661

#

Bu Sun Kim

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

[diff] [blame]

662

# title: "Summary size limit"

663

# description: "Determines if a summary is less than 100 chars"

664

# expression: "document.summary.size() < 100"

Dan O'Meara

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

[diff] [blame]

665

#

666

# Example (Equality):

667

#

Bu Sun Kim

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

[diff] [blame]

668

# title: "Requestor is owner"

669

# description: "Determines if requestor is the document owner"

670

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

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

[diff] [blame]

671

#

672

# Example (Logic):

673

#

Bu Sun Kim

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

[diff] [blame]

674

# title: "Public documents"

675

# description: "Determine whether the document should be publicly visible"

676

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

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

[diff] [blame]

677

#

678

# Example (Data Manipulation):

679

#

Bu Sun Kim

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

[diff] [blame]

680

# title: "Notification string"

681

# description: "Create a notification string with a timestamp."

682

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

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

[diff] [blame]

683

#

684

# The exact variables and functions that may be referenced within an expression

685

# are determined by the service that evaluates it. See the service

686

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

687

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Bu Sun Kim

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

[diff] [blame]

688

# its purpose. This can be used e.g. in UIs which allow to enter the

689

# expression.

Bu Sun Kim

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

[diff] [blame]

690

"location": "A String", # Optional. String indicating the location of the expression for error

691

# reporting, e.g. a file name and a position in the file.

692

"description": "A String", # Optional. Description of the expression. This is a longer text which

693

# describes the expression, e.g. when hovered over it in a UI.

694

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

695

# syntax.

Bu Sun Kim

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

[diff] [blame]

696

},

Bu Sun Kim

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

[diff] [blame]

697

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

698

# `members` can have the following values:

699

#

700

# * `allUsers`: A special identifier that represents anyone who is

701

# on the internet; with or without a Google account.

702

#

703

# * `allAuthenticatedUsers`: A special identifier that represents anyone

704

# who is authenticated with a Google account or a service account.

705

#

706

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

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

[diff] [blame]

707

# account. For example, `alice@example.com` .

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

708

#

709

#

710

# * `serviceAccount:{emailid}`: An email address that represents a service

711

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

712

#

713

# * `group:{emailid}`: An email address that represents a Google group.

714

# For example, `admins@example.com`.

715

#

Dan O'Meara

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

[diff] [blame]

716

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

717

# identifier) representing a user that has been recently deleted. For

718

# example, `alice@example.com?uid=123456789012345678901`. If the user is

719

# recovered, this value reverts to `user:{emailid}` and the recovered user

720

# retains the role in the binding.

721

#

722

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

723

# unique identifier) representing a service account that has been recently

724

# deleted. For example,

725

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

726

# If the service account is undeleted, this value reverts to

727

# `serviceAccount:{emailid}` and the undeleted service account retains the

728

# role in the binding.

729

#

730

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

731

# identifier) representing a Google group that has been recently

732

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

733

# the group is recovered, this value reverts to `group:{emailid}` and the

734

# recovered group retains the role in the binding.

735

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

736

#

Bu Sun Kim

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

[diff] [blame]

737

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

738

# users of that domain. For example, `google.com` or `example.com`.

739

#

Bu Sun Kim

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

[diff] [blame]

740

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

741

],

742

},

743

],

Bu Sun Kim

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

[diff] [blame]

744

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

745

# prevent simultaneous updates of a policy from overwriting each other.

746

# It is strongly suggested that systems make use of the `etag` in the

747

# read-modify-write cycle to perform policy updates in order to avoid race

748

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

749

# systems are expected to put that etag in the request to `setIamPolicy` to

750

# ensure that their change will be applied to the same version of the policy.

751

#

Dan O'Meara

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

[diff] [blame]

752

# **Important:** If you use IAM Conditions, you must include the `etag` field

753

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

754

# you to overwrite a version `3` policy with a version `1` policy, and all of

755

# the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

756

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

Dan O'Meara

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

[diff] [blame]

757

#

758

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

759

# are rejected.

760

#

761

# Any operation that affects conditional role bindings must specify version

762

# `3`. This requirement applies to the following operations:

763

#

764

# * Getting a policy that includes a conditional role binding

765

# * Adding a conditional role binding to a policy

766

# * Changing a conditional role binding in a policy

767

# * Removing any role binding, with or without a condition, from a policy

768

# that includes conditions

769

#

770

# **Important:** If you use IAM Conditions, you must include the `etag` field

771

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

772

# you to overwrite a version `3` policy with a version `1` policy, and all of

773

# the conditions in the version `3` policy are lost.

774

#

775

# If a policy does not include any conditions, operations on that policy may

776

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

777

#

778

# To learn which resources support conditions in their IAM policies, see the

779

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

784

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

Bu Sun Kim

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

[diff] [blame]

785

<pre>Lists Projects that the caller has the `resourcemanager.projects.get`

786

permission on and satisfy the specified filter.

787

788

This method returns Projects in an unspecified order.

789

This method is eventually consistent with project mutations; this means

790

that a newly created project may not appear in the results or recent

791

updates to an existing project may not be reflected in the results. To

792

retrieve the latest state of a project, use the

793

GetProject method.

794

795

NOTE: If the request filter contains a `parent.type` and `parent.id` and

796

the caller has the `resourcemanager.projects.list` permission on the

797

parent, the results will be drawn from an alternate index which provides

798

more consistent results. In future versions of this API, this List method

799

will be split into List and Search to properly capture the behavorial

800

difference.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

801

802

Args:

Bu Sun Kim

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

[diff] [blame]

803

filter: string, An expression for filtering the results of the request. Filter rules are

804

case insensitive. The fields eligible for filtering are:

805

806

+ `name`

807

+ `id`

Dan O'Meara

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

[diff] [blame]

808

+ `labels.<key>` (where *key* is the name of a label)

Bu Sun Kim

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

[diff] [blame]

+ `parent.type`

+ `parent.id`

Some examples of using labels as filters:

813

814

| Filter | Description |

815

|------------------|-----------------------------------------------------|

Bu Sun Kim

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

[diff] [blame]

816

| name:how* | The project's name starts with "how". |

817

| name:Howl | The project's name is `Howl` or `howl`. |

Bu Sun Kim

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

[diff] [blame]

818

| name:HOWL | Equivalent to above. |

819

| NAME:howl | Equivalent to above. |

820

| labels.color:* | The project has the label `color`. |

Bu Sun Kim

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

[diff] [blame]

821

| labels.color:red | The project's label `color` has the value `red`. |

822

| labels.color:red&nbsp;labels.size:big |The project's label `color` has

Bu Sun Kim

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

[diff] [blame]

823

the value `red` and its label `size` has the value `big`. |

824

825

If no filter is specified, the call will return projects for which the user

826

has the `resourcemanager.projects.get` permission.

827

828

NOTE: To perform a by-parent query (eg., what projects are directly in a

829

Folder), the caller must have the `resourcemanager.projects.list`

830

permission on the parent and the filter must contain both a `parent.type`

831

and a `parent.id` restriction

Bu Sun Kim

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

[diff] [blame]

832

(example: "parent.type:folder parent.id:123"). In this case an alternate

Bu Sun Kim

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

[diff] [blame]

833

search index is used which provides more consistent results.

834

835

Optional.

Bu Sun Kim

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

[diff] [blame]

836

pageToken: string, A pagination token returned from a previous call to ListProjects

837

that indicates from where listing should continue.

838

839

Optional.

840

pageSize: integer, The maximum number of Projects to return in the response.

841

The server can return fewer Projects than requested.

842

If unspecified, server picks an appropriate default.

843

844

Optional.

845

x__xgafv: string, V1 error format.

846

Allowed values

847

1 - v1 error format

848

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

849

850

Returns:

851

An object of the form:

852

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

853

{ # A page of the response received from the

# ListProjects

# method.

#

# A paginated response where more pages are available has

858

# `next_page_token` set. This token can be used in a subsequent request to

859

# retrieve the next request page.

Bu Sun Kim

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

[diff] [blame]

860

"projects": [ # The list of Projects that matched the list filter. This list can

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

861

# be paginated.

862

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

863

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

864

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

865

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

866

#

Bu Sun Kim

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

[diff] [blame]

867

# Read-only.

868

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

869

#

Bu Sun Kim

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

[diff] [blame]

870

# Example: <code>415104041262</code>

871

# Read-only.

872

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

873

#

874

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

875

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

876

# `UpdateProject` method; the end user must have the

877

# `resourcemanager.projects.create` permission on the parent.

878

#

879

# Read-write.

880

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

881

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

882

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

883

"type": "A String", # Required field representing the resource type this id is for.

884

# At present, the valid types are "project", "folder", and "organization".

885

"id": "A String", # Required field for the type-specific id. This should correspond to the id

886

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

887

},

Bu Sun Kim

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

[diff] [blame]

888

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

889

#

890

# Label keys must be between 1 and 63 characters long and must conform

891

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

892

#

893

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

894

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

895

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

896

#

897

# No more than 256 labels can be associated with a given resource.

898

#

899

# Clients should store labels in a representation such as JSON that does not

900

# depend on specific characters being disallowed.

901

#

Bu Sun Kim

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

[diff] [blame]

902

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

903

# Read-write.

Bu Sun Kim

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

[diff] [blame]

904

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

905

},

Bu Sun Kim

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

[diff] [blame]

906

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

907

#

908

# Read-only.

Bu Sun Kim

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

[diff] [blame]

909

"name": "A String", # The optional user-assigned display name of the Project.

910

# When present it must be between 4 to 30 characters.

911

# Allowed characters are: lowercase and uppercase letters, numbers,

912

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

913

#

Bu Sun Kim

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

[diff] [blame]

914

# Example: <code>My Project</code>

915

# Read-write.

916

"projectId": "A String", # The unique, user-assigned ID of the Project.

917

# It must be 6 to 30 lowercase letters, digits, or hyphens.

918

# It must start with a letter.

919

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

920

#

Bu Sun Kim

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

[diff] [blame]

921

# Example: <code>tokyo-rain-123</code>

922

# Read-only after creation.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

923

},

924

],

Bu Sun Kim

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

[diff] [blame]

925

"nextPageToken": "A String", # Pagination token.

926

#

927

# If the result set is too large to fit in a single response, this token

928

# is returned. It encodes the position of the current result cursor.

929

# Feeding this value into a new list request with the `page_token` parameter

930

# gives the next page of the results.

931

#

932

# When `next_page_token` is not filled in, there is no next page and

933

# the list returned is the last page in the result set.

934

#

935

# Pagination tokens have a limited lifetime.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

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

941

<pre>Retrieves the next page of results.

942

943

Args:

944

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

945

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

946

947

Returns:

Bu Sun Kim

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

[diff] [blame]

948

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

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

949

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

</pre>

</div>

Dan O'Meara

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

[diff] [blame]

954

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

Bu Sun Kim

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

[diff] [blame]

955

<pre>Sets the IAM access control policy for the specified Project. Overwrites

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

956

any existing policy.

957

958

The following constraints apply when using `setIamPolicy()`:

959

960

+ Project does not support `allUsers` and `allAuthenticatedUsers` as

961

`members` in a `Binding` of a `Policy`.

962

Dan O'Meara

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

[diff] [blame]

963

+ The owner role can be granted to a `user`, `serviceAccount`, or a group

964

that is part of an organization. For example,

965

group@myownpersonaldomain.com could be added as an owner to a project in

966

the myownpersonaldomain.com organization, but not the examplepetstore.com

967

organization.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

968

969

+ Service accounts can be made owners of a project directly

970

without any restrictions. However, to be added as an owner, a user must be

971

invited via Cloud Platform console and must accept the invitation.

972

973

+ A user cannot be granted the owner role using `setIamPolicy()`. The user

974

must be granted the owner role using the Cloud Platform Console and must

975

explicitly accept the invitation.

976

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

977

+ Invitations to grant the owner role cannot be sent using

978

`setIamPolicy()`; they must be sent only using the Cloud Platform Console.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

979

980

+ Membership changes that leave the project without any owners that have

981

accepted the Terms of Service (ToS) will be rejected.

982

Bu Sun Kim

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

[diff] [blame]

983

+ If the project is not part of an organization, there must be at least

984

one owner who has accepted the Terms of Service (ToS) agreement in the

985

policy. Calling `setIamPolicy()` to remove the last ToS-accepted owner

986

from the policy will fail. This restriction also applies to legacy

987

projects that no longer have owners who have accepted the ToS. Edits to

988

IAM policies will be rejected until the lack of a ToS-accepting owner is

989

rectified.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

990

Bu Sun Kim

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

[diff] [blame]

991

+ This method will replace the existing policy, and cannot be used to

992

append additional IAM settings.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

993

994

Note: Removing service accounts from policies or changing their roles

995

can render services completely inoperable. It is important to understand

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

996

how the service account is being used before removing or updating its

997

roles.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

998

999

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1000

resource: string, REQUIRED: The resource for which the policy is being specified.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1001

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

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

[diff] [blame]

1002

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1003

The object takes the form of:

1004

1005

{ # Request message for `SetIamPolicy` method.

Bu Sun Kim

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

[diff] [blame]

1006

"policy": { # An Identity and Access Management (IAM) policy, which specifies access # REQUIRED: The complete policy to be applied to the `resource`. The size of

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1007

# the policy is limited to a few 10s of KB. An empty policy is a

1008

# valid policy but certain Cloud Platform services (such as Projects)

1009

# might reject them.

Dan O'Meara

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

[diff] [blame]

1010

# controls for Google Cloud resources.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1011

#

1012

#

Dan O'Meara

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

[diff] [blame]

1013

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1014

# `members` to a single `role`. Members can be user accounts, service accounts,

1015

# Google groups, and domains (such as G Suite). A `role` is a named list of

1016

# permissions; each `role` can be an IAM predefined role or a user-created

1017

# custom role.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1018

#

Bu Sun Kim

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

[diff] [blame]

1019

# For some types of Google Cloud resources, a `binding` can also specify a

1020

# `condition`, which is a logical expression that allows access to a resource

1021

# only if the expression evaluates to `true`. A condition can add constraints

1022

# based on attributes of the request, the resource, or both. To learn which

1023

# resources support conditions in their IAM policies, see the

1024

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

1025

#

1026

# **JSON example:**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1027

#

1028

# {

Bu Sun Kim

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

[diff] [blame]

1029

# "bindings": [

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1030

# {

Bu Sun Kim

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

[diff] [blame]

1031

# "role": "roles/resourcemanager.organizationAdmin",

1032

# "members": [

1033

# "user:mike@example.com",

1034

# "group:admins@example.com",

1035

# "domain:google.com",

1036

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1037

# ]

1038

# },

1039

# {

Bu Sun Kim

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

[diff] [blame]

1040

# "role": "roles/resourcemanager.organizationViewer",

1041

# "members": [

1042

# "user:eve@example.com"

1043

# ],

1044

# "condition": {

1045

# "title": "expirable access",

1046

# "description": "Does not grant access after Sep 2020",

1047

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

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

[diff] [blame]

1048

# }

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1049

# }

Dan O'Meara

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

[diff] [blame]

1050

# ],

Bu Sun Kim

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

[diff] [blame]

1051

# "etag": "BwWWja0YfJA=",

1052

# "version": 3

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1053

# }

1054

#

Dan O'Meara

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

[diff] [blame]

1055

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1060

# - group:admins@example.com

1061

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1062

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1063

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1064

# - members:

Dan O'Meara

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

[diff] [blame]

1065

# - user:eve@example.com

1066

# role: roles/resourcemanager.organizationViewer

1067

# condition:

1068

# title: expirable access

1069

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1070

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

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

[diff] [blame]

1071

# - etag: BwWWja0YfJA=

1072

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1073

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1074

# For a description of IAM and its features, see the

Dan O'Meara

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

[diff] [blame]

1075

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

1076

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

1077

{ # Specifies the audit configuration for a service.

1078

# The configuration determines which permission types are logged, and what

1079

# identities, if any, are exempted from logging.

1080

# An AuditConfig must have one or more AuditLogConfigs.

1081

#

1082

# If there are AuditConfigs for both `allServices` and a specific service,

1083

# the union of the two AuditConfigs is used for that service: the log_types

1084

# specified in each AuditConfig are enabled, and the exempted_members in each

1085

# AuditLogConfig are exempted.

1086

#

1087

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1093

# "audit_log_configs": [

1094

# {

1095

# "log_type": "DATA_READ",

1096

# "exempted_members": [

1097

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1102

# },

1103

# {

1104

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

1110

# "audit_log_configs": [

1111

# {

1112

# "log_type": "DATA_READ",

1113

# },

1114

# {

1115

# "log_type": "DATA_WRITE",

1116

# "exempted_members": [

1117

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1126

# logging. It also exempts jose@example.com from DATA_READ logging, and

1127

# aliya@example.com from DATA_WRITE logging.

1128

"service": "A String", # Specifies a service that will be enabled for audit logging.

1129

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1130

# `allServices` is a special value that covers all services.

1131

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

1132

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

# Example:

#

# {

# "audit_log_configs": [

1137

# {

1138

# "log_type": "DATA_READ",

1139

# "exempted_members": [

1140

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1150

# jose@example.com from DATA_READ logging.

1151

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1152

# permission.

1153

# Follows the same format of Binding.members.

1154

"A String",

1155

],

1156

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

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

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

[diff] [blame]

1162

# `condition` that determines how and when the `bindings` are applied. Each

1163

# of the `bindings` must contain at least one member.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1164

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

Bu Sun Kim

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

[diff] [blame]

1165

"role": "A String", # Role that is assigned to `members`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1166

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

1167

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1168

#

1169

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

1170

# current request.

1171

#

1172

# If the condition evaluates to `false`, then this binding does not apply to

1173

# the current request. However, a different role binding might grant the same

1174

# role to one or more of the members in this binding.

1175

#

1176

# To learn which resources support conditions in their IAM policies, see the

1177

# [IAM

1178

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

1179

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1180

# are documented at https://github.com/google/cel-spec.

Bu Sun Kim

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

[diff] [blame]

1181

#

Dan O'Meara

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

[diff] [blame]

1182

# Example (Comparison):

1183

#

Bu Sun Kim

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

[diff] [blame]

1184

# title: "Summary size limit"

1185

# description: "Determines if a summary is less than 100 chars"

1186

# expression: "document.summary.size() < 100"

Dan O'Meara

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

[diff] [blame]

1187

#

1188

# Example (Equality):

1189

#

Bu Sun Kim

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

[diff] [blame]

1190

# title: "Requestor is owner"

1191

# description: "Determines if requestor is the document owner"

1192

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

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

[diff] [blame]

1193

#

1194

# Example (Logic):

1195

#

Bu Sun Kim

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

[diff] [blame]

1196

# title: "Public documents"

1197

# description: "Determine whether the document should be publicly visible"

1198

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

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

[diff] [blame]

1199

#

1200

# Example (Data Manipulation):

1201

#

Bu Sun Kim

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

[diff] [blame]

1202

# title: "Notification string"

1203

# description: "Create a notification string with a timestamp."

1204

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

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

[diff] [blame]

1205

#

1206

# The exact variables and functions that may be referenced within an expression

1207

# are determined by the service that evaluates it. See the service

1208

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1209

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Bu Sun Kim

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

[diff] [blame]

1210

# its purpose. This can be used e.g. in UIs which allow to enter the

1211

# expression.

Bu Sun Kim

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

[diff] [blame]

1212

"location": "A String", # Optional. String indicating the location of the expression for error

1213

# reporting, e.g. a file name and a position in the file.

1214

"description": "A String", # Optional. Description of the expression. This is a longer text which

1215

# describes the expression, e.g. when hovered over it in a UI.

1216

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

1217

# syntax.

Bu Sun Kim

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

[diff] [blame]

1218

},

Bu Sun Kim

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

[diff] [blame]

1219

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1220

# `members` can have the following values:

1221

#

1222

# * `allUsers`: A special identifier that represents anyone who is

1223

# on the internet; with or without a Google account.

1224

#

1225

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1226

# who is authenticated with a Google account or a service account.

1227

#

1228

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

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

[diff] [blame]

1229

# account. For example, `alice@example.com` .

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1230

#

1231

#

1232

# * `serviceAccount:{emailid}`: An email address that represents a service

1233

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1234

#

1235

# * `group:{emailid}`: An email address that represents a Google group.

1236

# For example, `admins@example.com`.

1237

#

Dan O'Meara

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

[diff] [blame]

1238

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1239

# identifier) representing a user that has been recently deleted. For

1240

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1241

# recovered, this value reverts to `user:{emailid}` and the recovered user

1242

# retains the role in the binding.

1243

#

1244

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1245

# unique identifier) representing a service account that has been recently

1246

# deleted. For example,

1247

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1248

# If the service account is undeleted, this value reverts to

1249

# `serviceAccount:{emailid}` and the undeleted service account retains the

1250

# role in the binding.

1251

#

1252

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1253

# identifier) representing a Google group that has been recently

1254

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1255

# the group is recovered, this value reverts to `group:{emailid}` and the

1256

# recovered group retains the role in the binding.

1257

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1258

#

Bu Sun Kim

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

[diff] [blame]

1259

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1260

# users of that domain. For example, `google.com` or `example.com`.

1261

#

Bu Sun Kim

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

[diff] [blame]

1262

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1263

],

1264

},

1265

],

Bu Sun Kim

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

[diff] [blame]

1266

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1267

# prevent simultaneous updates of a policy from overwriting each other.

1268

# It is strongly suggested that systems make use of the `etag` in the

1269

# read-modify-write cycle to perform policy updates in order to avoid race

1270

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1271

# systems are expected to put that etag in the request to `setIamPolicy` to

1272

# ensure that their change will be applied to the same version of the policy.

1273

#

Dan O'Meara

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

[diff] [blame]

1274

# **Important:** If you use IAM Conditions, you must include the `etag` field

1275

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1276

# you to overwrite a version `3` policy with a version `1` policy, and all of

1277

# the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

1278

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

Dan O'Meara

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

[diff] [blame]

1279

#

1280

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

1281

# are rejected.

1282

#

1283

# Any operation that affects conditional role bindings must specify version

1284

# `3`. This requirement applies to the following operations:

1285

#

1286

# * Getting a policy that includes a conditional role binding

1287

# * Adding a conditional role binding to a policy

1288

# * Changing a conditional role binding in a policy

1289

# * Removing any role binding, with or without a condition, from a policy

1290

# that includes conditions

1291

#

1292

# **Important:** If you use IAM Conditions, you must include the `etag` field

1293

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1294

# you to overwrite a version `3` policy with a version `1` policy, and all of

1295

# the conditions in the version `3` policy are lost.

1296

#

1297

# If a policy does not include any conditions, operations on that policy may

1298

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1299

#

1300

# To learn which resources support conditions in their IAM policies, see the

1301

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1302

},

Bu Sun Kim

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

[diff] [blame]

1303

"updateMask": "A String", # OPTIONAL: A FieldMask specifying which fields of the policy to modify. Only

Sai Cheemalapati

e833b79

2017-03-24 15:06:46 -0700

[diff] [blame]

1304

# the fields in the mask will be modified. If no mask is provided, the

1305

# following default mask is used:

Dan O'Meara

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

[diff] [blame]

1306

#

Bu Sun Kim

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

[diff] [blame]

1307

# `paths: "bindings, etag"`

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1308

}

1309

1310

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1311

Allowed values

1312

1 - v1 error format

1313

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1314

1315

Returns:

1316

An object of the form:

1317

Dan O'Meara

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

[diff] [blame]

1318

{ # An Identity and Access Management (IAM) policy, which specifies access

1319

# controls for Google Cloud resources.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1320

#

1321

#

Dan O'Meara

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

[diff] [blame]

1322

# A `Policy` is a collection of `bindings`. A `binding` binds one or more

1323

# `members` to a single `role`. Members can be user accounts, service accounts,

1324

# Google groups, and domains (such as G Suite). A `role` is a named list of

1325

# permissions; each `role` can be an IAM predefined role or a user-created

1326

# custom role.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1327

#

Bu Sun Kim

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

[diff] [blame]

1328

# For some types of Google Cloud resources, a `binding` can also specify a

1329

# `condition`, which is a logical expression that allows access to a resource

1330

# only if the expression evaluates to `true`. A condition can add constraints

1331

# based on attributes of the request, the resource, or both. To learn which

1332

# resources support conditions in their IAM policies, see the

1333

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

1334

#

1335

# **JSON example:**

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1336

#

1337

# {

Bu Sun Kim

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

[diff] [blame]

1338

# "bindings": [

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1339

# {

Bu Sun Kim

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

[diff] [blame]

1340

# "role": "roles/resourcemanager.organizationAdmin",

1341

# "members": [

1342

# "user:mike@example.com",

1343

# "group:admins@example.com",

1344

# "domain:google.com",

1345

# "serviceAccount:my-project-id@appspot.gserviceaccount.com"

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1346

# ]

1347

# },

1348

# {

Bu Sun Kim

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

[diff] [blame]

1349

# "role": "roles/resourcemanager.organizationViewer",

1350

# "members": [

1351

# "user:eve@example.com"

1352

# ],

1353

# "condition": {

1354

# "title": "expirable access",

1355

# "description": "Does not grant access after Sep 2020",

1356

# "expression": "request.time < timestamp('2020-10-01T00:00:00.000Z')",

Dan O'Meara

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

[diff] [blame]

1357

# }

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1358

# }

Dan O'Meara

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

[diff] [blame]

1359

# ],

Bu Sun Kim

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

[diff] [blame]

1360

# "etag": "BwWWja0YfJA=",

1361

# "version": 3

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1362

# }

1363

#

Dan O'Meara

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

[diff] [blame]

1364

# **YAML example:**

Bu Sun Kim

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

[diff] [blame]

#

# bindings:

# - members:

# - user:mike@example.com

1369

# - group:admins@example.com

1370

# - domain:google.com

Dan O'Meara

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

[diff] [blame]

1371

# - serviceAccount:my-project-id@appspot.gserviceaccount.com

1372

# role: roles/resourcemanager.organizationAdmin

Bu Sun Kim

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

[diff] [blame]

1373

# - members:

Dan O'Meara

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

[diff] [blame]

1374

# - user:eve@example.com

1375

# role: roles/resourcemanager.organizationViewer

1376

# condition:

1377

# title: expirable access

1378

# description: Does not grant access after Sep 2020

Bu Sun Kim

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

[diff] [blame]

1379

# expression: request.time < timestamp('2020-10-01T00:00:00.000Z')

Dan O'Meara

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

[diff] [blame]

1380

# - etag: BwWWja0YfJA=

1381

# - version: 3

Bu Sun Kim

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

[diff] [blame]

1382

#

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1383

# For a description of IAM and its features, see the

Dan O'Meara

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

[diff] [blame]

1384

# [IAM documentation](https://cloud.google.com/iam/docs/).

Bu Sun Kim

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

[diff] [blame]

1385

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

1386

{ # Specifies the audit configuration for a service.

1387

# The configuration determines which permission types are logged, and what

1388

# identities, if any, are exempted from logging.

1389

# An AuditConfig must have one or more AuditLogConfigs.

1390

#

1391

# If there are AuditConfigs for both `allServices` and a specific service,

1392

# the union of the two AuditConfigs is used for that service: the log_types

1393

# specified in each AuditConfig are enabled, and the exempted_members in each

1394

# AuditLogConfig are exempted.

1395

#

1396

# Example Policy with multiple AuditConfigs:

#

# {

# "audit_configs": [

# {

# "service": "allServices"

1402

# "audit_log_configs": [

1403

# {

1404

# "log_type": "DATA_READ",

1405

# "exempted_members": [

1406

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

1411

# },

1412

# {

1413

# "log_type": "ADMIN_READ",

# }

# ]

# },

# {

# "service": "sampleservice.googleapis.com"

1419

# "audit_log_configs": [

1420

# {

1421

# "log_type": "DATA_READ",

1422

# },

1423

# {

1424

# "log_type": "DATA_WRITE",

1425

# "exempted_members": [

1426

# "user:aliya@example.com"

# ]

# }

# ]

# }

# ]

# }

#

# For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ

1435

# logging. It also exempts jose@example.com from DATA_READ logging, and

1436

# aliya@example.com from DATA_WRITE logging.

1437

"service": "A String", # Specifies a service that will be enabled for audit logging.

1438

# For example, `storage.googleapis.com`, `cloudsql.googleapis.com`.

1439

# `allServices` is a special value that covers all services.

1440

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

1441

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

# Example:

#

# {

# "audit_log_configs": [

1446

# {

1447

# "log_type": "DATA_READ",

1448

# "exempted_members": [

1449

# "user:jose@example.com"

# ]

# },

# {

# "log_type": "DATA_WRITE",

# }

# ]

# }

#

# This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting

1459

# jose@example.com from DATA_READ logging.

1460

"exemptedMembers": [ # Specifies the identities that do not cause logging for this type of

1461

# permission.

1462

# Follows the same format of Binding.members.

1463

"A String",

1464

],

1465

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

},

],

},

],

"bindings": [ # Associates a list of `members` to a `role`. Optionally, may specify a

Dan O'Meara

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

[diff] [blame]

1471

# `condition` that determines how and when the `bindings` are applied. Each

1472

# of the `bindings` must contain at least one member.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1473

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

Bu Sun Kim

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

[diff] [blame]

1474

"role": "A String", # Role that is assigned to `members`.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1475

# For example, `roles/viewer`, `roles/editor`, or `roles/owner`.

Bu Sun Kim

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

[diff] [blame]

1476

"condition": { # Represents a textual expression in the Common Expression Language (CEL) # The condition that is associated with this binding.

1477

#

1478

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

1479

# current request.

1480

#

1481

# If the condition evaluates to `false`, then this binding does not apply to

1482

# the current request. However, a different role binding might grant the same

1483

# role to one or more of the members in this binding.

1484

#

1485

# To learn which resources support conditions in their IAM policies, see the

1486

# [IAM

1487

# documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Dan O'Meara

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

[diff] [blame]

1488

# syntax. CEL is a C-like expression language. The syntax and semantics of CEL

1489

# are documented at https://github.com/google/cel-spec.

Bu Sun Kim

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

[diff] [blame]

1490

#

Dan O'Meara

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

[diff] [blame]

1491

# Example (Comparison):

1492

#

Bu Sun Kim

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

[diff] [blame]

1493

# title: "Summary size limit"

1494

# description: "Determines if a summary is less than 100 chars"

1495

# expression: "document.summary.size() < 100"

Dan O'Meara

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

[diff] [blame]

1496

#

1497

# Example (Equality):

1498

#

Bu Sun Kim

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

[diff] [blame]

1499

# title: "Requestor is owner"

1500

# description: "Determines if requestor is the document owner"

1501

# expression: "document.owner == request.auth.claims.email"

Dan O'Meara

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

[diff] [blame]

1502

#

1503

# Example (Logic):

1504

#

Bu Sun Kim

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

[diff] [blame]

1505

# title: "Public documents"

1506

# description: "Determine whether the document should be publicly visible"

1507

# expression: "document.type != 'private' && document.type != 'internal'"

Dan O'Meara

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

[diff] [blame]

1508

#

1509

# Example (Data Manipulation):

1510

#

Bu Sun Kim

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

[diff] [blame]

1511

# title: "Notification string"

1512

# description: "Create a notification string with a timestamp."

1513

# expression: "'New message received at ' + string(document.create_time)"

Dan O'Meara

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

[diff] [blame]

1514

#

1515

# The exact variables and functions that may be referenced within an expression

1516

# are determined by the service that evaluates it. See the service

1517

# documentation for additional information.

Bu Sun Kim

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

[diff] [blame]

1518

"title": "A String", # Optional. Title for the expression, i.e. a short string describing

Bu Sun Kim

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

[diff] [blame]

1519

# its purpose. This can be used e.g. in UIs which allow to enter the

1520

# expression.

Bu Sun Kim

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

[diff] [blame]

1521

"location": "A String", # Optional. String indicating the location of the expression for error

1522

# reporting, e.g. a file name and a position in the file.

1523

"description": "A String", # Optional. Description of the expression. This is a longer text which

1524

# describes the expression, e.g. when hovered over it in a UI.

1525

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

1526

# syntax.

Bu Sun Kim

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

[diff] [blame]

1527

},

Bu Sun Kim

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

[diff] [blame]

1528

"members": [ # Specifies the identities requesting access for a Cloud Platform resource.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1529

# `members` can have the following values:

1530

#

1531

# * `allUsers`: A special identifier that represents anyone who is

1532

# on the internet; with or without a Google account.

1533

#

1534

# * `allAuthenticatedUsers`: A special identifier that represents anyone

1535

# who is authenticated with a Google account or a service account.

1536

#

1537

# * `user:{emailid}`: An email address that represents a specific Google

Dan O'Meara

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

[diff] [blame]

1538

# account. For example, `alice@example.com` .

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1539

#

1540

#

1541

# * `serviceAccount:{emailid}`: An email address that represents a service

1542

# account. For example, `my-other-app@appspot.gserviceaccount.com`.

1543

#

1544

# * `group:{emailid}`: An email address that represents a Google group.

1545

# For example, `admins@example.com`.

1546

#

Dan O'Meara

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

[diff] [blame]

1547

# * `deleted:user:{emailid}?uid={uniqueid}`: An email address (plus unique

1548

# identifier) representing a user that has been recently deleted. For

1549

# example, `alice@example.com?uid=123456789012345678901`. If the user is

1550

# recovered, this value reverts to `user:{emailid}` and the recovered user

1551

# retains the role in the binding.

1552

#

1553

# * `deleted:serviceAccount:{emailid}?uid={uniqueid}`: An email address (plus

1554

# unique identifier) representing a service account that has been recently

1555

# deleted. For example,

1556

# `my-other-app@appspot.gserviceaccount.com?uid=123456789012345678901`.

1557

# If the service account is undeleted, this value reverts to

1558

# `serviceAccount:{emailid}` and the undeleted service account retains the

1559

# role in the binding.

1560

#

1561

# * `deleted:group:{emailid}?uid={uniqueid}`: An email address (plus unique

1562

# identifier) representing a Google group that has been recently

1563

# deleted. For example, `admins@example.com?uid=123456789012345678901`. If

1564

# the group is recovered, this value reverts to `group:{emailid}` and the

1565

# recovered group retains the role in the binding.

1566

#

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1567

#

Bu Sun Kim

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

[diff] [blame]

1568

# * `domain:{domain}`: The G Suite domain (primary) that represents all the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1569

# users of that domain. For example, `google.com` or `example.com`.

1570

#

Bu Sun Kim

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

[diff] [blame]

1571

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1572

],

1573

},

1574

],

Bu Sun Kim

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

[diff] [blame]

1575

"etag": "A String", # `etag` is used for optimistic concurrency control as a way to help

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

1576

# prevent simultaneous updates of a policy from overwriting each other.

1577

# It is strongly suggested that systems make use of the `etag` in the

1578

# read-modify-write cycle to perform policy updates in order to avoid race

1579

# conditions: An `etag` is returned in the response to `getIamPolicy`, and

1580

# systems are expected to put that etag in the request to `setIamPolicy` to

1581

# ensure that their change will be applied to the same version of the policy.

1582

#

Dan O'Meara

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

[diff] [blame]

1583

# **Important:** If you use IAM Conditions, you must include the `etag` field

1584

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1585

# you to overwrite a version `3` policy with a version `1` policy, and all of

1586

# the conditions in the version `3` policy are lost.

Bu Sun Kim

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

[diff] [blame]

1587

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

Dan O'Meara

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

[diff] [blame]

1588

#

1589

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

1590

# are rejected.

1591

#

1592

# Any operation that affects conditional role bindings must specify version

1593

# `3`. This requirement applies to the following operations:

1594

#

1595

# * Getting a policy that includes a conditional role binding

1596

# * Adding a conditional role binding to a policy

1597

# * Changing a conditional role binding in a policy

1598

# * Removing any role binding, with or without a condition, from a policy

1599

# that includes conditions

1600

#

1601

# **Important:** If you use IAM Conditions, you must include the `etag` field

1602

# whenever you call `setIamPolicy`. If you omit this field, then IAM allows

1603

# you to overwrite a version `3` policy with a version `1` policy, and all of

1604

# the conditions in the version `3` policy are lost.

1605

#

1606

# If a policy does not include any conditions, operations on that policy may

1607

# specify any valid version or leave the field unset.

Bu Sun Kim

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

[diff] [blame]

1608

#

1609

# To learn which resources support conditions in their IAM policies, see the

1610

# [IAM documentation](https://cloud.google.com/iam/help/conditions/resource-policies).

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1615

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

Jon Wayne Parrott

36e41bc

2016-02-19 16:02:29 -0800

[diff] [blame]

1616

<pre>Returns permissions that a caller has on the specified Project.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1617

1618

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1619

resource: string, REQUIRED: The resource for which the policy detail is being requested.

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1620

See the operation documentation for the appropriate value for this field. (required)

Dan O'Meara

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

[diff] [blame]

1621

body: object, The request body.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1622

The object takes the form of:

1623

1624

{ # Request message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1625

"permissions": [ # The set of permissions to check for the `resource`. Permissions with

1626

# wildcards (such as '*' or 'storage.*') are not allowed. For more

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1627

# information see

1628

# [IAM Overview](https://cloud.google.com/iam/docs/overview#permissions).

Bu Sun Kim

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

[diff] [blame]

1629

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

],

}

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1634

Allowed values

1635

1 - v1 error format

1636

2 - v2 error format

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1637

1638

Returns:

1639

An object of the form:

1640

1641

{ # Response message for `TestIamPermissions` method.

Bu Sun Kim

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

[diff] [blame]

1642

"permissions": [ # A subset of `TestPermissionsRequest.permissions` that the caller is

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1643

# allowed.

Bu Sun Kim

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

[diff] [blame]

1644

"A String",

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

],

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

1650

<code class="details" id="undelete">undelete(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1651

<pre>Restores the Project identified by the specified

1652

`project_id` (for example, `my-project-123`).

1653

You can only use this method for a Project that has a lifecycle state of

1654

DELETE_REQUESTED.

1655

After deletion starts, the Project cannot be restored.

1656

1657

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1658

1659

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1660

projectId: string, The project ID (for example, `foo-bar-123`).

1661

1662

Required. (required)

Bu Sun Kim

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

[diff] [blame]

1663

body: object, The request body.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1664

The object takes the form of:

1665

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1666

{ # The request sent to the UndeleteProject

1667

# method.

Sai Cheemalapati

2016-10-21 13:59:49 -0700

[diff] [blame]

1668

}

1669

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1670

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1671

Allowed values

1672

1 - v1 error format

1673

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1674

1675

Returns:

1676

An object of the form:

1677

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1678

{ # A generic empty message that you can re-use to avoid defining duplicated

1679

# empty messages in your APIs. A typical example is to use it as the request

1680

# or the response type of an API method. For instance:

1681

#

1682

# service Foo {

1683

# rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);

1684

# }

1685

#

1686

# The JSON representation for `Empty` is empty JSON object `{}`.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

[diff] [blame]

1691

<code class="details" id="update">update(projectId, body=None, x__xgafv=None)</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1692

<pre>Updates the attributes of the Project identified by the specified

1693

`project_id` (for example, `my-project-123`).

1694

1695

The caller must have modify permissions for this Project.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1696

1697

Args:

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1698

projectId: string, The project ID (for example, `my-project-123`).

1699

1700

Required. (required)

Dan O'Meara

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

[diff] [blame]

1701

body: object, The request body.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1702

The object takes the form of:

1703

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1704

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1705

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1706

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

1707

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1708

#

Bu Sun Kim

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

[diff] [blame]

1709

# Read-only.

1710

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1711

#

Bu Sun Kim

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

[diff] [blame]

1712

# Example: <code>415104041262</code>

1713

# Read-only.

1714

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

1715

#

1716

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

1717

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1718

# `UpdateProject` method; the end user must have the

1719

# `resourcemanager.projects.create` permission on the parent.

1720

#

1721

# Read-write.

1722

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

1723

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1724

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

1725

"type": "A String", # Required field representing the resource type this id is for.

1726

# At present, the valid types are "project", "folder", and "organization".

1727

"id": "A String", # Required field for the type-specific id. This should correspond to the id

1728

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1729

},

Bu Sun Kim

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

[diff] [blame]

1730

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1731

#

1732

# Label keys must be between 1 and 63 characters long and must conform

1733

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

1734

#

1735

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

1736

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

1737

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1738

#

1739

# No more than 256 labels can be associated with a given resource.

1740

#

1741

# Clients should store labels in a representation such as JSON that does not

1742

# depend on specific characters being disallowed.

1743

#

Bu Sun Kim

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

[diff] [blame]

1744

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1745

# Read-write.

Bu Sun Kim

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

[diff] [blame]

1746

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1747

},

Bu Sun Kim

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

[diff] [blame]

1748

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1749

#

1750

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1751

"name": "A String", # The optional user-assigned display name of the Project.

1752

# When present it must be between 4 to 30 characters.

1753

# Allowed characters are: lowercase and uppercase letters, numbers,

1754

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1755

#

Bu Sun Kim

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

[diff] [blame]

1756

# Example: <code>My Project</code>

1757

# Read-write.

1758

"projectId": "A String", # The unique, user-assigned ID of the Project.

1759

# It must be 6 to 30 lowercase letters, digits, or hyphens.

1760

# It must start with a letter.

1761

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1762

#

Bu Sun Kim

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

[diff] [blame]

1763

# Example: <code>tokyo-rain-123</code>

1764

# Read-only after creation.

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1765

}

1766

1767

x__xgafv: string, V1 error format.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1768

Allowed values

1769

1 - v1 error format

1770

2 - v2 error format

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1771

1772

Returns:

1773

An object of the form:

1774

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1775

{ # A Project is a high-level Google Cloud Platform entity. It is a

Sai Cheemalapati

2017-03-13 12:12:03 -0400

[diff] [blame]

1776

# container for ACLs, APIs, App Engine Apps, VMs, and other

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1777

# Google Cloud Platform resources.

Bu Sun Kim

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

[diff] [blame]

1778

"lifecycleState": "A String", # The Project lifecycle state.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1779

#

Bu Sun Kim

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

[diff] [blame]

1780

# Read-only.

1781

"projectNumber": "A String", # The number uniquely identifying the project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1782

#

Bu Sun Kim

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

[diff] [blame]

1783

# Example: <code>415104041262</code>

1784

# Read-only.

1785

"parent": { # A container to reference an id for any resource type. A `resource` in Google # An optional reference to a parent Resource.

1786

#

1787

# Supported parent types include "organization" and "folder". Once set, the

Bu Sun Kim

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

[diff] [blame]

1788

# parent cannot be cleared. The `parent` can be set on creation or using the

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1789

# `UpdateProject` method; the end user must have the

1790

# `resourcemanager.projects.create` permission on the parent.

1791

#

1792

# Read-write.

1793

# Cloud Platform is a generic term for something you (a developer) may want to

Bu Sun Kim

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

[diff] [blame]

1794

# interact with through one of our API's. Some examples are an App Engine app,

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1795

# a Compute Engine instance, a Cloud SQL database, and so on.

Bu Sun Kim

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

[diff] [blame]

1796

"type": "A String", # Required field representing the resource type this id is for.

1797

# At present, the valid types are "project", "folder", and "organization".

1798

"id": "A String", # Required field for the type-specific id. This should correspond to the id

1799

# used in the type-specific API's.

Takashi Matsuo

2015-09-11 13:55:40 -0700

[diff] [blame]

1800

},

Bu Sun Kim

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

[diff] [blame]

1801

"labels": { # The labels associated with this Project.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1802

#

1803

# Label keys must be between 1 and 63 characters long and must conform

1804

# to the following regular expression: \[a-z\](\[-a-z0-9\]*\[a-z0-9\])?.

1805

#

1806

# Label values must be between 0 and 63 characters long and must conform

Bu Sun Kim

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

[diff] [blame]

1807

# to the regular expression (\[a-z\](\[-a-z0-9\]*\[a-z0-9\])?)?. A label

1808

# value can be empty.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1809

#

1810

# No more than 256 labels can be associated with a given resource.

1811

#

1812

# Clients should store labels in a representation such as JSON that does not

1813

# depend on specific characters being disallowed.

1814

#

Bu Sun Kim

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

[diff] [blame]

1815

# Example: <code>"environment" : "dev"</code>

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1816

# Read-write.

Bu Sun Kim

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

[diff] [blame]

1817

"a_key": "A String",

Nathaniel Manista

2015-06-15 16:44:50 +0000

[diff] [blame]

1818

},

Bu Sun Kim

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

[diff] [blame]

1819

"createTime": "A String", # Creation time.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1820

#

1821

# Read-only.

Bu Sun Kim

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

[diff] [blame]

1822

"name": "A String", # The optional user-assigned display name of the Project.

1823

# When present it must be between 4 to 30 characters.

1824

# Allowed characters are: lowercase and uppercase letters, numbers,

1825

# hyphen, single-quote, double-quote, space, and exclamation point.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1826

#

Bu Sun Kim

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

[diff] [blame]

1827

# Example: <code>My Project</code>

1828

# Read-write.

1829

"projectId": "A String", # The unique, user-assigned ID of the Project.

1830

# It must be 6 to 30 lowercase letters, digits, or hyphens.

1831

# It must start with a letter.

1832

# Trailing hyphens are prohibited.

Jon Wayne Parrott

2017-01-06 09:58:29 -0800

[diff] [blame]

1833

#

Bu Sun Kim

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

[diff] [blame]

1834

# Example: <code>tokyo-rain-123</code>

1835

# Read-only after creation.

Nathaniel Manista