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

<h1><a href="accessapproval_v1.html">Access Approval API</a> . <a href="accessapproval_v1.projects.html">projects</a> . <a href="accessapproval_v1.projects.approvalRequests.html">approvalRequests</a></h1>

76

<h2>Instance Methods</h2>

77

78

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

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

4ed7d3f

2020-05-27 12:20:54 -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

6502091

2020-05-20 12:08:20 -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

94

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

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:

body: object, The request body.

103

The object takes the form of:

104

105

{ # Request to approve an ApprovalRequest.

106

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

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

4ed7d3f

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

[diff] [blame]

118

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

119

# resource name is defined at

120

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

121

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

122

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

123

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

124

# resource name specification.

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

},

133

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

134

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

135

# requested.

136

},

137

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

138

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

139

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

140

},

141

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

Bu Sun Kim

6502091

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

[diff] [blame]

142

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

Bu Sun Kim

6502091

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

[diff] [blame]

143

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

144

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

145

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

146

# of a country code.

147

# Possible Region Codes:

148

# <ol>

149

# <li>ASI: Asia</li>

150

# <li>EUR: Europe</li>

151

# <li>OCE: Oceania</li>

152

# <li>AFR: Africa</li>

153

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

154

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

155

# <li>ANT: Antarctica</li>

156

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

157

# </ol>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

158

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

159

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

160

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

161

# a region code instead of a country code.

162

# Possible Region Codes:

163

# <ol>

164

# <li>ASI: Asia</li>

165

# <li>EUR: Europe</li>

166

# <li>OCE: Oceania</li>

167

# <li>AFR: Africa</li>

168

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

169

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

170

# <li>ANT: Antarctica</li>

171

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

172

# </ol>

Bu Sun Kim

6502091

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

[diff] [blame]

173

},

174

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

175

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

176

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -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

4ed7d3f

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

[diff] [blame]

210

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

211

# resource name is defined at

212

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

213

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

214

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

215

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

216

# resource name specification.

217

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

218

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

219

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

220

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

221

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

222

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

223

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

224

},

225

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

226

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

227

# requested.

228

},

229

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

230

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

231

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

232

},

233

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

Bu Sun Kim

6502091

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

[diff] [blame]

234

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

Bu Sun Kim

6502091

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

[diff] [blame]

235

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

236

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

237

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

238

# of a country code.

239

# Possible Region Codes:

240

# <ol>

241

# <li>ASI: Asia</li>

242

# <li>EUR: Europe</li>

243

# <li>OCE: Oceania</li>

244

# <li>AFR: Africa</li>

245

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

246

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

247

# <li>ANT: Antarctica</li>

248

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

249

# </ol>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

250

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

251

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

252

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

253

# a region code instead of a country code.

254

# Possible Region Codes:

255

# <ol>

256

# <li>ASI: Asia</li>

257

# <li>EUR: Europe</li>

258

# <li>OCE: Oceania</li>

259

# <li>AFR: Africa</li>

260

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

261

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

262

# <li>ANT: Antarctica</li>

263

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

264

# </ol>

Bu Sun Kim

6502091

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

[diff] [blame]

265

},

266

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

267

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

268

},

Bu Sun Kim

6502091

2020-05-20 12:08:20 -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

4ed7d3f

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

[diff] [blame]

287

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

288

# resource name is defined at

289

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

290

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

291

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

292

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

293

# resource name specification.

294

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

295

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

296

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

297

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

298

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

299

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

300

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

301

},

302

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

303

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

304

# requested.

305

},

306

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

307

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

308

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

309

},

310

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

Bu Sun Kim

6502091

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

[diff] [blame]

311

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

Bu Sun Kim

6502091

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

[diff] [blame]

312

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

313

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

314

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

315

# of a country code.

316

# Possible Region Codes:

317

# <ol>

318

# <li>ASI: Asia</li>

319

# <li>EUR: Europe</li>

320

# <li>OCE: Oceania</li>

321

# <li>AFR: Africa</li>

322

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

323

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

324

# <li>ANT: Antarctica</li>

325

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

326

# </ol>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

327

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

328

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

329

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

330

# a region code instead of a country code.

331

# Possible Region Codes:

332

# <ol>

333

# <li>ASI: Asia</li>

334

# <li>EUR: Europe</li>

335

# <li>OCE: Oceania</li>

336

# <li>AFR: Africa</li>

337

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

338

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

339

# <li>ANT: Antarctica</li>

340

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

341

# </ol>

Bu Sun Kim

6502091

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

[diff] [blame]

342

},

343

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

344

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

345

},

Bu Sun Kim

6502091

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

350

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

Bu Sun Kim

6502091

2020-05-20 12:08:20 -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:

356

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

357

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

358

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

359

pageSize: integer, Requested page size.

Bu Sun Kim

6502091

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

[diff] [blame]

360

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

361

following values:

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>

368

</ol>

Bu Sun Kim

6502091

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

[diff] [blame]

369

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

376

377

{ # Response to listing of ApprovalRequest objects.

378

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

379

"approvalRequests": [ # Approval request details.

380

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

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

381

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

382

# resource name is defined at

383

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

384

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

385

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

386

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

387

# resource name specification.

388

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

389

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

390

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

391

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

392

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

393

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

394

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

395

},

396

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

397

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

398

# requested.

399

},

400

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

401

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

402

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

403

},

404

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

Bu Sun Kim

6502091

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

[diff] [blame]

405

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

Bu Sun Kim

6502091

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

[diff] [blame]

406

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

407

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

408

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

409

# of a country code.

410

# Possible Region Codes:

411

# <ol>

412

# <li>ASI: Asia</li>

413

# <li>EUR: Europe</li>

414

# <li>OCE: Oceania</li>

415

# <li>AFR: Africa</li>

416

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

417

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

418

# <li>ANT: Antarctica</li>

419

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

420

# </ol>

Bu Sun Kim

4ed7d3f

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

[diff] [blame]

421

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

422

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

423

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

424

# a region code instead of a country code.

425

# Possible Region Codes:

426

# <ol>

427

# <li>ASI: Asia</li>

428

# <li>EUR: Europe</li>

429

# <li>OCE: Oceania</li>

430

# <li>AFR: Africa</li>

431

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

432

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

433

# <li>ANT: Antarctica</li>

434

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

435

# </ol>

Bu Sun Kim

6502091

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

[diff] [blame]

436

},

437

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

438

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

439

},

Bu Sun Kim

6502091

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

[diff] [blame]

},

],

}</pre>

</div>

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

447

<pre>Retrieves the next page of results.

448

449

Args:

450

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

451

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

452

453

Returns:

454

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

455

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

</pre>

</div>

</body></html>