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

[diff] [blame]

118

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

119

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

120

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

121

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

122

# of a country code.

Bu Sun Kim

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

[diff] [blame]

123

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

124

# <ol>

125

# <li>ASI: Asia</li>

126

# <li>EUR: Europe</li>

127

# <li>OCE: Oceania</li>

128

# <li>AFR: Africa</li>

129

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

130

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

131

# <li>ANT: Antarctica</li>

132

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

133

# </ol>

Bu Sun Kim

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

[diff] [blame]

134

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

135

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

136

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

137

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

138

# Possible Region Codes:

139

# <ol>

140

# <li>ASI: Asia</li>

141

# <li>EUR: Europe</li>

142

# <li>OCE: Oceania</li>

143

# <li>AFR: Africa</li>

144

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

145

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

146

# <li>ANT: Antarctica</li>

147

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

148

# </ol>

Bu Sun Kim

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

[diff] [blame]

149

},

Bu Sun Kim

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

[diff] [blame]

150

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

151

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

152

},

153

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

154

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

155

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

156

# resource name is defined at

157

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

158

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

159

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

160

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

161

# resource name specification.

162

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

163

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

164

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

165

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

166

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

167

},

168

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

169

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

170

# requested.

171

},

172

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

173

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

174

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

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

[diff] [blame]

210

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

211

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

212

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

213

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

214

# of a country code.

Bu Sun Kim

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

[diff] [blame]

215

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

216

# <ol>

217

# <li>ASI: Asia</li>

218

# <li>EUR: Europe</li>

219

# <li>OCE: Oceania</li>

220

# <li>AFR: Africa</li>

221

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

222

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

223

# <li>ANT: Antarctica</li>

224

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

225

# </ol>

Bu Sun Kim

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

[diff] [blame]

226

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

227

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

228

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

229

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

230

# Possible Region Codes:

231

# <ol>

232

# <li>ASI: Asia</li>

233

# <li>EUR: Europe</li>

234

# <li>OCE: Oceania</li>

235

# <li>AFR: Africa</li>

236

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

237

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

238

# <li>ANT: Antarctica</li>

239

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

240

# </ol>

Bu Sun Kim

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

[diff] [blame]

241

},

Bu Sun Kim

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

[diff] [blame]

242

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

243

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

244

},

245

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

246

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

247

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

248

# resource name is defined at

249

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

250

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

251

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

252

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

253

# resource name specification.

254

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

255

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

256

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

257

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

258

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

259

},

260

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

261

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

262

# requested.

263

},

264

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

265

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

266

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

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

[diff] [blame]

287

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

288

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

289

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

290

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

291

# of a country code.

Bu Sun Kim

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

[diff] [blame]

292

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

293

# <ol>

294

# <li>ASI: Asia</li>

295

# <li>EUR: Europe</li>

296

# <li>OCE: Oceania</li>

297

# <li>AFR: Africa</li>

298

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

299

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

300

# <li>ANT: Antarctica</li>

301

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

302

# </ol>

Bu Sun Kim

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

[diff] [blame]

303

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

304

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

305

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

306

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

307

# Possible Region Codes:

308

# <ol>

309

# <li>ASI: Asia</li>

310

# <li>EUR: Europe</li>

311

# <li>OCE: Oceania</li>

312

# <li>AFR: Africa</li>

313

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

314

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

315

# <li>ANT: Antarctica</li>

316

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

317

# </ol>

Bu Sun Kim

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

[diff] [blame]

318

},

Bu Sun Kim

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

[diff] [blame]

319

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

320

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

321

},

322

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

323

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

324

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

325

# resource name is defined at

326

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

327

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

328

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

329

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

330

# resource name specification.

331

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

332

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

333

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

334

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

335

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

336

},

337

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

338

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

339

# requested.

340

},

341

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

342

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

343

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

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>

368

</ol>

Bu Sun Kim

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

[diff] [blame]

369

x__xgafv: string, V1 error format.

370

Allowed values

371

1 - v1 error format

372

2 - v2 error format

Bu Sun Kim

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

[diff] [blame]

373

374

Returns:

375

An object of the form:

376

377

{ # Response to listing of ApprovalRequest objects.

Bu Sun Kim

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

[diff] [blame]

378

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

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

[diff] [blame]

381

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

382

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

383

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

384

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

385

# of a country code.

Bu Sun Kim

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

[diff] [blame]

386

# Possible Region Codes:

Dan O'Meara

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

[diff] [blame]

387

# <ol>

388

# <li>ASI: Asia</li>

389

# <li>EUR: Europe</li>

390

# <li>OCE: Oceania</li>

391

# <li>AFR: Africa</li>

392

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

393

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

394

# <li>ANT: Antarctica</li>

395

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

396

# </ol>

Bu Sun Kim

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

[diff] [blame]

397

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

398

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

399

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

400

# a region code instead of a country code.

Dan O'Meara

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

[diff] [blame]

401

# Possible Region Codes:

402

# <ol>

403

# <li>ASI: Asia</li>

404

# <li>EUR: Europe</li>

405

# <li>OCE: Oceania</li>

406

# <li>AFR: Africa</li>

407

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

408

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

409

# <li>ANT: Antarctica</li>

410

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

411

# </ol>

Bu Sun Kim

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

[diff] [blame]

412

},

Bu Sun Kim