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
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
|
<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.developers.html">developers</a> . <a href="apigee_v1.organizations.developers.apps.html">apps</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.developers.apps.attributes.html">attributes()</a></code>
</p>
<p class="firstline">Returns the attributes Resource.</p>
<p class="toc_element">
<code><a href="apigee_v1.organizations.developers.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 associated with a developer. This API associates the developer 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. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a developer app. **Note**: The delete operation is asynchronous. The developer 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="#generateKeyPairOrUpdateDeveloperAppStatus">generateKeyPairOrUpdateDeveloperAppStatus(name, action=None, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approved` or `revoked`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still `approved`. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approved` or `revoked`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.</p>
<p class="toc_element">
<code><a href="#get">get(name, entity=None, query=None, x__xgafv=None)</a></code></p>
<p class="firstline">Returns the details for a developer app.</p>
<p class="toc_element">
<code><a href="#list">list(parent, count=None, expand=None, shallowExpand=None, startKey=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters.</p>
<p class="toc_element">
<code><a href="#update">update(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates the details for a developer app. In addition, you can add an API product to a developer 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 UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. 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 associated with a developer. This API associates the developer 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. The `DisplayName` (set as an attribute) appears in the UI. If you don't set the `DisplayName` attribute, the `name` appears in the UI.
Args:
parent: string, Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. 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:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a developer app. **Note**: The delete operation is asynchronous. The developer 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/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:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="generateKeyPairOrUpdateDeveloperAppStatus">generateKeyPairOrUpdateDeveloperAppStatus(name, action=None, body=None, x__xgafv=None)</code>
<pre>Manages access to a developer app by enabling you to: * Approve or revoke a developer app * Generate a new consumer key and secret for a developer app To approve or revoke a developer app, set the `action` query parameter to `approved` or `revoked`, respectively, and the `Content-Type` header to `application/octet-stream`. If a developer app is revoked, none of its API keys are valid for API calls even though the keys are still `approved`. If successful, the API call returns the following HTTP status code: `204 No Content` To generate a new consumer key and secret for a developer app, pass the new key/secret details. Rather than replace an existing key, this API generates a new key. In this case, multiple key pairs may be associated with a single developer app. Each key pair has an independent status (`approved` or `revoked`) and expiration time. Any approved, non-expired key can be used in an API call. For example, if you're using API key rotation, you can generate new keys with expiration times that overlap keys that are going to expire. You might also generate a new consumer key/secret if the security of the original key/secret is compromised. The `keyExpiresIn` property defines the expiration time for the API key in milliseconds. If you don't set this property or set it to `-1`, the API key never expires. **Notes**: * When generating a new key/secret, this API replaces the existing attributes, notes, and callback URLs with those specified in the request. Include or exclude any existing information that you want to retain or delete, respectively. * To migrate existing consumer keys and secrets to hybrid from another system, see the CreateDeveloperAppKey API.
Args:
name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}
action: string, Action. Valid values are `approve` or `revoke`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, entity=None, query=None, x__xgafv=None)</code>
<pre>Returns the details for a developer app.
Args:
name: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required)
entity: string, **Note**: Must be used in conjunction with the `query` parameter. Set to `apiresources` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.
query: string, **Note**: Must be used in conjunction with the `entity` parameter. Set to `count` to return the number of API resources that have been approved for access by a developer app in the specified Apigee organization.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, count=None, expand=None, shallowExpand=None, startKey=None, x__xgafv=None)</code>
<pre>Lists all apps created by a developer in an Apigee organization. Optionally, you can request an expanded view of the developer apps. A maximum of 100 developer apps are returned per API call. You can paginate the list of deveoper apps returned using the `startKey` and `count` query parameters.
Args:
parent: string, Required. Name of the developer. Use the following structure in your request: `organizations/{org}/developers/{developer_email}` (required)
count: string, Number of developer apps to return in the API call. Use with the `startKey` parameter to provide more targeted filtering. The limit is 1000.
expand: boolean, Optional. Specifies whether to expand the results. Set to `true` to expand the results. This query parameter is not valid if you use the `count` or `startKey` query parameters.
shallowExpand: boolean, Optional. Specifies whether to expand the results in shallow mode. Set to `true` to expand the results in shallow mode.
startKey: string, **Note**: Must be used in conjunction with the `count` parameter. Name of the developer app from which to start displaying the list of developer apps. For example, if you're returning 50 developer apps at a time (using the `count` query parameter), you can view developer apps 50-99 by entering the name of the 50th developer app. The developer app name is case sensitive.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"app": [ # List of developer apps and their credentials.
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="update">update(name, body=None, x__xgafv=None)</code>
<pre>Updates the details for a developer app. In addition, you can add an API product to a developer 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 UpdateDeveloperAppKey API. Using this API, you cannot update the following: * App name as it is the primary key used to identify the app and cannot be changed. * Scopes associated with the app. Instead, use the ReplaceDeveloperAppKey API. 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 developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required)
body: object, The request body.
The object takes the form of:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. 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:
{
"apiProducts": [ # List of API products associated with the developer app.
"A String",
],
"appFamily": "A String", # Developer app family.
"appId": "A String", # ID of the developer app.
"attributes": [ # List of attributes for the developer 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 developer apps.
"createdAt": "A String", # Output only. Time the developer app was created in milliseconds since epoch.
"credentials": [ # Output only. Set of credentials for the developer 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.
},
],
"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`.
},
],
"developerId": "A String", # ID of the developer.
"keyExpiresIn": "A String", # Expiration time, in milliseconds, for the consumer key that is generated for the developer 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 developer app was modified in milliseconds since epoch.
"name": "A String", # Name of the developer app.
"scopes": [ # Scopes to apply to the developer app. The specified scopes must already exist for the API product that you associate with the developer app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
</body></html>
|
