1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="apigee_v1.html">Apigee API</a> . <a href="apigee_v1.organizations.html">organizations</a> . <a href="apigee_v1.organizations.appgroups.html">appgroups</a> . <a href="apigee_v1.organizations.appgroups.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.appgroups.apps.keys.html">keys()</a></code>
</p>
<p class="firstline">Returns the keys Resource.</p>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates an app and associates it with an AppGroup. This API associates the AppGroup app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the details for an AppGroup app.</p>
<p class="toc_element">
<code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#update">update(name, action=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates an app and associates it with an AppGroup. This API associates the AppGroup app with the specified API product and auto-generates an API key for the app to use in calls to API proxies inside that API product. The `name` is the unique ID of the app that you can use in API calls.
Args:
parent: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
body: object, The request body.
The object takes the form of:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes an AppGroup app. **Note**: The delete operation is asynchronous. The AppGroup app is deleted immediately, but its associated resources, such as app keys or access tokens, may take anywhere from a few seconds to a few minutes to be deleted.
Args:
name: string, Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Returns the details for an AppGroup app.
Args:
name: string, Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all apps created by an AppGroup in an Apigee organization. Optionally, you can request an expanded view of the AppGroup apps. Lists all AppGroupApps in an AppGroup. A maximum of 1000 AppGroup apps are returned in the response if PageSize is not specified, or if the PageSize is greater than 1000.
Args:
parent: string, Required. Name of the AppGroup. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}` (required)
pageSize: integer, Optional. Maximum number entries to return. If unspecified, at most 1000 entries will be returned.
pageToken: string, Optional. Page token. If provides, must be a valid AppGroup app returned from a previous call that can be used to retrieve the next page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListAppGroupApps
"appGroupApps": [ # List of AppGroup apps and their credentials.
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
},
],
"nextPageToken": "A String", # Token that can be sent as `next_page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, action=None, body=None, x__xgafv=None)</code>
<pre>Updates the details for an AppGroup app. In addition, you can add an API product to an AppGroup app and automatically generate an API key for the app to use when calling APIs in the API product. If you want to use an existing API key for the API product, add the API product to the API key using the UpdateAppGroupAppKey API. Using this API, you cannot update the app name, as it is the primary key used to identify the app and cannot be changed. This API replaces the existing attributes with those specified in the request. Include or exclude any existing attributes that you want to retain or delete, respectively.
Args:
name: string, Required. Name of the AppGroup app. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}` (required)
body: object, The request body.
The object takes the form of:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}
action: string, Approve or revoke the consumer key by setting this value to `approve` or `revoke`. The `Content-Type` header must be set to `application/octet-stream`, with empty body.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for [GetAppGroupApp].[AppGroupApps.GetAppGroupApp], [CreateAppGroupAppRequest].[AppGroupApp.CreateAppGroupAppRequest] and [DeleteAppGroupApp].[AppGroupApp.DeleteAppGroupApp]
"apiProducts": [ # List of API products associated with the AppGroup app.
"A String",
],
"appGroup": "A String", # Immutable. Name of the parent AppGroup whose resource name format is of syntax (organizations/*/appgroups/*).
"appId": "A String", # Immutable. ID of the AppGroup app.
"attributes": [ # List of attributes for the AppGroup app.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"callbackUrl": "A String", # Callback URL used by OAuth 2.0 authorization servers to communicate authorization codes back to AppGroup apps.
"createdAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the AppGroup app consisting of the consumer key/secret pairs associated with the API products.
{
"apiProducts": [ # List of API products this credential can be used for.
{
"apiproduct": "A String", # Name of the API product.
"status": "A String", # Status of the API product. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with this credential.
{ # Key-value pair to store extra metadata.
"name": "A String", # API key of the attribute.
"value": "A String", # Value of the attribute.
},
],
"consumerKey": "A String", # Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Time the credential will expire in milliseconds since epoch.
"issuedAt": "A String", # Time the credential was issued in milliseconds since epoch.
"scopes": [ # List of scopes to apply to the app. Specified scopes must already exist on the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
"keyExpiresIn": "A String", # Immutable. Expiration time, in seconds, for the consumer key that is generated for the AppGroup app. If not set or left to the default value of `-1`, the API key never expires. The expiration time can't be updated after it is set.
"lastModifiedAt": "A String", # Output only. Time the AppGroup app was modified in milliseconds since epoch.
"name": "A String", # Immutable. Name of the AppGroup app whose resource name format is of syntax (organizations/*/appgroups/*/apps/*).
"scopes": [ # Scopes to apply to the AppGroup app. The specified scopes must already exist for the API product that you associate with the AppGroup app.
"A String",
],
"status": "A String", # Status of the App. Valid values include `approved` or `revoked`.
}</pre>
</div>
</body></html>
|
