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

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

[diff] [blame]

78

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

Bu Sun Kim

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

[diff] [blame]

79

<p class="firstline">Approves a request and returns the updated ApprovalRequest.</p>

80

81

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

82

<p class="firstline">Dismisses a request. Returns the updated ApprovalRequest.</p>

83

84

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

85

<p class="firstline">Gets an approval request. Returns NOT_FOUND if the request does not exist.</p>

86

Bu Sun Kim

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

[diff] [blame]

87

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

Bu Sun Kim

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

[diff] [blame]

88

<p class="firstline">Lists approval requests associated with a project, folder, or organization.</p>

89

90

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

91

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

92

<h3>Method Details</h3>

93

Dan O'Meara

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

[diff] [blame]

94

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

Bu Sun Kim

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

[diff] [blame]

95

<pre>Approves a request and returns the updated ApprovalRequest.

96

97

Returns NOT_FOUND if the request does not exist. Returns

98

FAILED_PRECONDITION if the request exists but is not in a pending state.

Args:

Dan O'Meara

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

[diff] [blame]

102

body: object, The request body.

Bu Sun Kim

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

[diff] [blame]

103

The object takes the form of:

104

105

{ # Request to approve an ApprovalRequest.

Bu Sun Kim

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

[diff] [blame]

106

"expireTime": "A String", # The expiration time of this approval.

Bu Sun Kim

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

[diff] [blame]

107

}

108

109

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

116

117

{ # A request for the customer to approve access to a resource.

Bu Sun Kim

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

[diff] [blame]

118

"name": "A String", # The resource name of the request. Format is

119

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

120

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

121

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

122

# requested.

123

},

124

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

125

# resource name is defined at

126

# https://cloud.google.com/apis/design/resource_names. The resource name here

127

# may either be a "full" resource name (e.g.

128

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

129

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

130

# resource name specification.

131

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

132

"approveTime": "A String", # The time at which approval was granted.

133

"expireTime": "A String", # The time at which the approval expires.

134

},

135

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

136

# access will be granted from the time of approval until the expiration time.

Bu Sun Kim

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

[diff] [blame]

137

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

Bu Sun Kim

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

[diff] [blame]

138

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

139

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

140

# limited situations Google systems may refer refer to a region code instead

141

# of a country code.

Bu Sun Kim

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

[diff] [blame]

142

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

143

# <ol>

144

# <li>ASI: Asia</li>

145

# <li>EUR: Europe</li>

146

# <li>OCE: Oceania</li>

147

# <li>AFR: Africa</li>

148

# <li>NAM: North America</li>

149

# <li>SAM: South America</li>

150

# <li>ANT: Antarctica</li>

151

# <li>ANY: Any location</li>

152

# </ol>

Bu Sun Kim

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

[diff] [blame]

153

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

154

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

155

# a region code. In some limited situations Google systems may refer refer to

156

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

157

# Possible Region Codes:

158

# <ol>

159

# <li>ASI: Asia</li>

160

# <li>EUR: Europe</li>

161

# <li>OCE: Oceania</li>

162

# <li>AFR: Africa</li>

163

# <li>NAM: North America</li>

164

# <li>SAM: South America</li>

165

# <li>ANT: Antarctica</li>

166

# <li>ANY: Any location</li>

167

# </ol>

Bu Sun Kim

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

[diff] [blame]

168

},

Bu Sun Kim

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

[diff] [blame]

169

"requestedReason": { # The justification for which approval is being requested.

170

"type": "A String", # Type of access justification.

171

"detail": "A String", # More detail about certain reason types. See comments for each type above.

172

},

Bu Sun Kim

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

[diff] [blame]

173

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

174

"dismissTime": "A String", # The time at which the approval request was dismissed.

175

},

Bu Sun Kim

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

[diff] [blame]

176

"requestTime": "A String", # The time at which approval was requested.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

182

<pre>Dismisses a request. Returns the updated ApprovalRequest.

183

184

NOTE: This does not deny access to the resource if another request has been

185

made and approved. It is equivalent in effect to ignoring the request

186

altogether.

187

188

Returns NOT_FOUND if the request does not exist.

189

190

Returns FAILED_PRECONDITION if the request exists but is not in a pending

state.

Args:

body: object, The request body.

196

The object takes the form of:

197

198

{ # Request to dismiss an approval request.

199

}

200

201

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

208

209

{ # A request for the customer to approve access to a resource.

Bu Sun Kim

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

[diff] [blame]

210

"name": "A String", # The resource name of the request. Format is

211

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

212

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

213

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

214

# requested.

215

},

216

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

217

# resource name is defined at

218

# https://cloud.google.com/apis/design/resource_names. The resource name here

219

# may either be a "full" resource name (e.g.

220

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

221

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

222

# resource name specification.

223

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

224

"approveTime": "A String", # The time at which approval was granted.

225

"expireTime": "A String", # The time at which the approval expires.

226

},

227

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

228

# access will be granted from the time of approval until the expiration time.

Bu Sun Kim

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

[diff] [blame]

229

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

Bu Sun Kim

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

[diff] [blame]

230

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

231

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

232

# limited situations Google systems may refer refer to a region code instead

233

# of a country code.

Bu Sun Kim

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

[diff] [blame]

234

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

235

# <ol>

236

# <li>ASI: Asia</li>

237

# <li>EUR: Europe</li>

238

# <li>OCE: Oceania</li>

239

# <li>AFR: Africa</li>

240

# <li>NAM: North America</li>

241

# <li>SAM: South America</li>

242

# <li>ANT: Antarctica</li>

243

# <li>ANY: Any location</li>

244

# </ol>

Bu Sun Kim

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

[diff] [blame]

245

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

246

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

247

# a region code. In some limited situations Google systems may refer refer to

248

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

249

# Possible Region Codes:

250

# <ol>

251

# <li>ASI: Asia</li>

252

# <li>EUR: Europe</li>

253

# <li>OCE: Oceania</li>

254

# <li>AFR: Africa</li>

255

# <li>NAM: North America</li>

256

# <li>SAM: South America</li>

257

# <li>ANT: Antarctica</li>

258

# <li>ANY: Any location</li>

259

# </ol>

Bu Sun Kim

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

[diff] [blame]

260

},

Bu Sun Kim

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

[diff] [blame]

261

"requestedReason": { # The justification for which approval is being requested.

262

"type": "A String", # Type of access justification.

263

"detail": "A String", # More detail about certain reason types. See comments for each type above.

264

},

Bu Sun Kim

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

[diff] [blame]

265

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

266

"dismissTime": "A String", # The time at which the approval request was dismissed.

267

},

Bu Sun Kim

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

[diff] [blame]

268

"requestTime": "A String", # The time at which approval was requested.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

274

<pre>Gets an approval request. Returns NOT_FOUND if the request does not exist.

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

285

286

{ # A request for the customer to approve access to a resource.

Bu Sun Kim

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

[diff] [blame]

287

"name": "A String", # The resource name of the request. Format is

288

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

289

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

290

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

291

# requested.

292

},

293

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

294

# resource name is defined at

295

# https://cloud.google.com/apis/design/resource_names. The resource name here

296

# may either be a "full" resource name (e.g.

297

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

298

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

299

# resource name specification.

300

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

301

"approveTime": "A String", # The time at which approval was granted.

302

"expireTime": "A String", # The time at which the approval expires.

303

},

304

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

305

# access will be granted from the time of approval until the expiration time.

Bu Sun Kim

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

[diff] [blame]

306

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

Bu Sun Kim

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

[diff] [blame]

307

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

308

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

309

# limited situations Google systems may refer refer to a region code instead

310

# of a country code.

Bu Sun Kim

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

[diff] [blame]

311

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

312

# <ol>

313

# <li>ASI: Asia</li>

314

# <li>EUR: Europe</li>

315

# <li>OCE: Oceania</li>

316

# <li>AFR: Africa</li>

317

# <li>NAM: North America</li>

318

# <li>SAM: South America</li>

319

# <li>ANT: Antarctica</li>

320

# <li>ANY: Any location</li>

321

# </ol>

Bu Sun Kim

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

[diff] [blame]

322

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

323

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

324

# a region code. In some limited situations Google systems may refer refer to

325

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

326

# Possible Region Codes:

327

# <ol>

328

# <li>ASI: Asia</li>

329

# <li>EUR: Europe</li>

330

# <li>OCE: Oceania</li>

331

# <li>AFR: Africa</li>

332

# <li>NAM: North America</li>

333

# <li>SAM: South America</li>

334

# <li>ANT: Antarctica</li>

335

# <li>ANY: Any location</li>

336

# </ol>

Bu Sun Kim

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

[diff] [blame]

337

},

Bu Sun Kim

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

[diff] [blame]

338

"requestedReason": { # The justification for which approval is being requested.

339

"type": "A String", # Type of access justification.

340

"detail": "A String", # More detail about certain reason types. See comments for each type above.

341

},

Bu Sun Kim

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

[diff] [blame]

342

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

343

"dismissTime": "A String", # The time at which the approval request was dismissed.

344

},

Bu Sun Kim

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

[diff] [blame]

345

"requestTime": "A String", # The time at which approval was requested.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

350

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

Bu Sun Kim

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

[diff] [blame]

351

<pre>Lists approval requests associated with a project, folder, or organization.

352

Approval requests can be filtered by state (pending, active, dismissed).

353

The order is reverse chronological.

354

355

Args:

Bu Sun Kim

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

[diff] [blame]

356

parent: string, The parent resource. This may be "projects/{project_id}",

357

"folders/{folder_id}", or "organizations/{organization_id}". (required)

Bu Sun Kim

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

[diff] [blame]

358

pageToken: string, A token identifying the page of results to return.

Dan O'Meara

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

[diff] [blame]

359

pageSize: integer, Requested page size.

Bu Sun Kim

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

[diff] [blame]

360

filter: string, A filter on the type of approval requests to retrieve. Must be one of the

361

following values:

Dan O'Meara

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

[diff] [blame]

362

<ol>

363

<li>[not set]: Requests that are pending or have active approvals.</li>

364

<li>ALL: All requests.</li>

365

<li>PENDING: Only pending requests.</li>

366

<li>ACTIVE: Only active (i.e. currently approved) requests.</li>

367

<li>DISMISSED: Only dismissed (including expired) requests.</li>

Bu Sun Kim

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

[diff] [blame]

368

<li>HISTORY: Active and dismissed (including expired) requests.</li>

Dan O'Meara

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

[diff] [blame]

369

</ol>

Bu Sun Kim

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

[diff] [blame]

370

x__xgafv: string, V1 error format.

371

Allowed values

372

1 - v1 error format

373

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

374

375

Returns:

376

An object of the form:

377

378

{ # Response to listing of ApprovalRequest objects.

Bu Sun Kim

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

[diff] [blame]

379

"approvalRequests": [ # Approval request details.

Bu Sun Kim

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

[diff] [blame]

380

{ # A request for the customer to approve access to a resource.

Bu Sun Kim

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

[diff] [blame]

381

"name": "A String", # The resource name of the request. Format is

382

# "{projects|folders|organizations}/{id}/approvalRequests/{approval_request_id}".

383

"requestedResourceProperties": { # The properties associated with the resource of the request. # Properties related to the resource represented by requested_resource_name.

384

"excludesDescendants": True or False, # Whether an approval will exclude the descendants of the resource being

385

# requested.

386

},

387

"requestedResourceName": "A String", # The resource for which approval is being requested. The format of the

388

# resource name is defined at

389

# https://cloud.google.com/apis/design/resource_names. The resource name here

390

# may either be a "full" resource name (e.g.

391

# "//library.googleapis.com/shelves/shelf1/books/book2") or a "relative"

392

# resource name (e.g. "shelves/shelf1/books/book2") as described in the

393

# resource name specification.

394

"approve": { # A decision that has been made to approve access to a resource. # Access was approved.

395

"approveTime": "A String", # The time at which approval was granted.

396

"expireTime": "A String", # The time at which the approval expires.

397

},

398

"requestedExpiration": "A String", # The requested expiration for the approval. If the request is approved,

399

# access will be granted from the time of approval until the expiration time.

Bu Sun Kim

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

[diff] [blame]

400

"requestedLocations": { # Home office and physical location of the principal. # The locations for which approval is being requested.

Bu Sun Kim

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

[diff] [blame]

401

"principalOfficeCountry": "A String", # The "home office" location of the principal. A two-letter country code

402

# (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or a region code. In some

403

# limited situations Google systems may refer refer to a region code instead

404

# of a country code.

Bu Sun Kim

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

[diff] [blame]

405

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

406

# <ol>

407

# <li>ASI: Asia</li>

408

# <li>EUR: Europe</li>

409

# <li>OCE: Oceania</li>

410

# <li>AFR: Africa</li>

411

# <li>NAM: North America</li>

412

# <li>SAM: South America</li>

413

# <li>ANT: Antarctica</li>

414

# <li>ANY: Any location</li>

415

# </ol>

Bu Sun Kim

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

[diff] [blame]

416

"principalPhysicalLocationCountry": "A String", # Physical location of the principal at the time of the access. A

417

# two-letter country code (ISO 3166-1 alpha-2), such as "US", "DE" or "GB" or

418

# a region code. In some limited situations Google systems may refer refer to

419

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

420

# Possible Region Codes:

421

# <ol>

422

# <li>ASI: Asia</li>

423

# <li>EUR: Europe</li>

424

# <li>OCE: Oceania</li>

425

# <li>AFR: Africa</li>

426

# <li>NAM: North America</li>

427

# <li>SAM: South America</li>

428

# <li>ANT: Antarctica</li>

429

# <li>ANY: Any location</li>

430

# </ol>

Bu Sun Kim

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

[diff] [blame]

431

},

Bu Sun Kim

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

[diff] [blame]

432

"requestedReason": { # The justification for which approval is being requested.

433

"type": "A String", # Type of access justification.

434

"detail": "A String", # More detail about certain reason types. See comments for each type above.

435

},

Bu Sun Kim

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

[diff] [blame]

436

"dismiss": { # A decision that has been made to dismiss an approval request. # The request was dismissed.

437

"dismissTime": "A String", # The time at which the approval request was dismissed.

438

},

Bu Sun Kim

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

[diff] [blame]

439

"requestTime": "A String", # The time at which approval was requested.

Bu Sun Kim

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

[diff] [blame]

440

},

441

],

Bu Sun Kim

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

[diff] [blame]

442

"nextPageToken": "A String", # Token to retrieve the next page of results, or empty if there are no more.

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

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

448

<pre>Retrieves the next page of results.

449

450

Args:

451

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

452

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

453

454

Returns:

Bu Sun Kim

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

[diff] [blame]

455

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

Bu Sun Kim