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

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

[diff] [blame]

87

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

Bu Sun Kim

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

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

[diff] [blame]

118

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

119

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

120

# requested.

121

},

Bu Sun Kim

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

[diff] [blame]

122

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

123

# resource name is defined at

124

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

125

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

126

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

127

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

128

# resource name specification.

Bu Sun Kim

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

[diff] [blame]

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

},

Bu Sun Kim

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

[diff] [blame]

133

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

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

137

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

138

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

139

},

140

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

141

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

142

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

143

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

144

},

Bu Sun Kim

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

[diff] [blame]

145

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

Bu Sun Kim

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

[diff] [blame]

146

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

147

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

148

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

149

# of a country code.

150

# Possible Region Codes:

151

# <ol>

152

# <li>ASI: Asia</li>

153

# <li>EUR: Europe</li>

154

# <li>OCE: Oceania</li>

155

# <li>AFR: Africa</li>

156

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

157

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

158

# <li>ANT: Antarctica</li>

159

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

160

# </ol>

Bu Sun Kim

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

[diff] [blame]

161

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

162

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

163

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

164

# a region code instead of a country code.

165

# Possible Region Codes:

166

# <ol>

167

# <li>ASI: Asia</li>

168

# <li>EUR: Europe</li>

169

# <li>OCE: Oceania</li>

170

# <li>AFR: Africa</li>

171

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

172

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

173

# <li>ANT: Antarctica</li>

174

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

175

# </ol>

Bu Sun Kim

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

[diff] [blame]

176

},

Bu Sun Kim

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

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

[diff] [blame]

210

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

211

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

212

# requested.

213

},

Bu Sun Kim

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

[diff] [blame]

214

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

215

# resource name is defined at

216

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

217

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

218

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

219

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

220

# resource name specification.

Bu Sun Kim

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

[diff] [blame]

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

},

Bu Sun Kim

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

[diff] [blame]

225

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

Bu Sun Kim

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

[diff] [blame]

226

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

227

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

228

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

229

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

230

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

231

},

232

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

233

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

234

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

235

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

236

},

Bu Sun Kim

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

[diff] [blame]

237

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

Bu Sun Kim

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

[diff] [blame]

238

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

239

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

240

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

241

# of a country code.

242

# Possible Region Codes:

243

# <ol>

244

# <li>ASI: Asia</li>

245

# <li>EUR: Europe</li>

246

# <li>OCE: Oceania</li>

247

# <li>AFR: Africa</li>

248

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

249

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

250

# <li>ANT: Antarctica</li>

251

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

252

# </ol>

Bu Sun Kim

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

[diff] [blame]

253

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

254

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

255

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

256

# a region code instead of a country code.

257

# Possible Region Codes:

258

# <ol>

259

# <li>ASI: Asia</li>

260

# <li>EUR: Europe</li>

261

# <li>OCE: Oceania</li>

262

# <li>AFR: Africa</li>

263

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

264

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

265

# <li>ANT: Antarctica</li>

266

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

267

# </ol>

Bu Sun Kim

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

[diff] [blame]

268

},

Bu Sun Kim

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

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

[diff] [blame]

287

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

288

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

289

# requested.

290

},

Bu Sun Kim

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

[diff] [blame]

291

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

292

# resource name is defined at

293

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

294

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

295

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

296

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

297

# resource name specification.

Bu Sun Kim

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

[diff] [blame]

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

},

Bu Sun Kim

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

[diff] [blame]

302

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

Bu Sun Kim

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

[diff] [blame]

303

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

304

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

305

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

306

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

307

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

308

},

309

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

310

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

311

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

312

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

313

},

Bu Sun Kim

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

[diff] [blame]

314

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

Bu Sun Kim

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

[diff] [blame]

315

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

316

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

317

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

318

# of a country code.

319

# Possible Region Codes:

320

# <ol>

321

# <li>ASI: Asia</li>

322

# <li>EUR: Europe</li>

323

# <li>OCE: Oceania</li>

324

# <li>AFR: Africa</li>

325

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

326

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

327

# <li>ANT: Antarctica</li>

328

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

329

# </ol>

Bu Sun Kim

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

[diff] [blame]

330

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

331

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

332

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

333

# a region code instead of a country code.

334

# Possible Region Codes:

335

# <ol>

336

# <li>ASI: Asia</li>

337

# <li>EUR: Europe</li>

338

# <li>OCE: Oceania</li>

339

# <li>AFR: Africa</li>

340

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

341

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

342

# <li>ANT: Antarctica</li>

343

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

344

# </ol>

Bu Sun Kim

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

[diff] [blame]

345

},

Bu Sun Kim

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

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

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

[diff] [blame]

350

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

Bu Sun Kim

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)

358

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

359

following values:

360

<ol>

361

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

362

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

363

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

364

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

365

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

Bu Sun Kim

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

[diff] [blame]

366

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

Bu Sun Kim

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

[diff] [blame]

367

</ol>

Bu Sun Kim

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

[diff] [blame]

368

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

369

pageSize: integer, Requested page size.

Bu Sun Kim

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

[diff] [blame]

370

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

377

378

{ # Response to listing of ApprovalRequest objects.

379

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

380

"approvalRequests": [ # Approval request details.

381

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

Bu Sun Kim

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

[diff] [blame]

382

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

383

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

384

# requested.

385

},

Bu Sun Kim

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

[diff] [blame]

386

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

387

# resource name is defined at

388

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

389

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

390

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

391

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

392

# resource name specification.

Bu Sun Kim

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

[diff] [blame]

393

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

394

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

395

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

396

},

Bu Sun Kim

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

[diff] [blame]

397

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

Bu Sun Kim

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

[diff] [blame]

398

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

399

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

400

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

401

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

402

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

403

},

404

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

405

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

406

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

407

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

408

},

Bu Sun Kim

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

[diff] [blame]

409

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

Bu Sun Kim

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

[diff] [blame]

410

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

411

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

412

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

413

# of a country code.

414

# Possible Region Codes:

415

# <ol>

416

# <li>ASI: Asia</li>

417

# <li>EUR: Europe</li>

418

# <li>OCE: Oceania</li>

419

# <li>AFR: Africa</li>

420

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

421

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

422

# <li>ANT: Antarctica</li>

423

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

424

# </ol>

Bu Sun Kim

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

[diff] [blame]

425

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

426

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

427

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

428

# a region code instead of a country code.

429

# Possible Region Codes:

430

# <ol>

431

# <li>ASI: Asia</li>

432

# <li>EUR: Europe</li>

433

# <li>OCE: Oceania</li>

434

# <li>AFR: Africa</li>

435

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

436

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

437

# <li>ANT: Antarctica</li>

438

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

439

# </ol>

Bu Sun Kim

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

[diff] [blame]

440

},

Bu Sun Kim