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
|
<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> . <a href="apigee_v1.organizations.appgroups.apps.keys.html">keys</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="apigee_v1.organizations.appgroups.apps.keys.apiproducts.html">apiproducts()</a></code>
</p>
<p class="firstline">Returns the apiproducts 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 a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.</p>
<p class="toc_element">
<code><a href="#updateAppGroupAppKey">updateAppGroupAppKey(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. 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. You can use the same key to access all API products associated with the app.</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 a custom consumer key and secret for a AppGroup app. This is particularly useful if you want to migrate existing consumer keys and secrets to Apigee from another system. Consumer keys and secrets can contain letters, numbers, underscores, and hyphens. No other special characters are allowed. To avoid service disruptions, a consumer key and secret should not exceed 2 KBs each. **Note**: When creating the consumer key and secret, an association to API products will not be made. Therefore, you should not specify the associated API products in your request. Instead, use the UpdateAppGroupAppKey API to make the association after the consumer key and secret are created. If a consumer key and secret already exist, you can keep them or delete them using the DeleteAppGroupAppKey API.
Args:
parent: string, Required. Parent of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys` (required)
body: object, The request body.
The object takes the form of:
{ # AppGroupAppKey contains all the information associated with the credentials.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the 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:
{ # AppGroupAppKey contains all the information associated with the credentials.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the 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 an app's consumer key and removes all API products associated with the app. After the consumer key is deleted, it cannot be used to access any APIs.
Args:
name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AppGroupAppKey contains all the information associated with the credentials.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the 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, x__xgafv=None)</code>
<pre>Gets details for a consumer key for a AppGroup app, including the key and secret value, associated API products, and other information.
Args:
name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # AppGroupAppKey contains all the information associated with the credentials.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the 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="updateAppGroupAppKey">updateAppGroupAppKey(name, body=None, x__xgafv=None)</code>
<pre>Adds an API product to an AppGroupAppKey, enabling the app that holds the key to access the API resources bundled in the API product. In addition, you can add attributes and scopes to the AppGroupAppKey. 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. You can use the same key to access all API products associated with the app.
Args:
name: string, Required. Name of the AppGroup app key. Use the following structure in your request: `organizations/{org}/appgroups/{app_group_name}/apps/{app}/keys/{key}` (required)
body: object, The request body.
The object takes the form of:
{ # Request for UpdateAppGroupAppKey
"action": "A String", # Approve or revoke the consumer key by setting this value to `approve` or `revoke` respectively. The `Content-Type` header, if set, must be set to `application/octet-stream`, with empty body.
"apiProducts": [ # The list of API products that will be associated with the credential. This list will be appended to the existing list of associated API Products for this App Key. Duplicates will be ignored.
"A String",
],
"appGroupAppKey": { # AppGroupAppKey contains all the information associated with the credentials. # Note that only Scopes and Attributes of the AppGroupAppKey can be amended. Scopes and Attributes mentioned in the request will be inserted and the existing scopes and attributes will be removed.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the 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:
{ # AppGroupAppKey contains all the information associated with the credentials.
"apiProducts": [ # Output only. List of API products and its status for which the credential can be used. **Note**: Use UpdateAppGroupAppKeyApiProductRequest API to make the association after the consumer key and secret are created.
{ # APIProductAssociation has the API product and its administrative state association.
"apiproduct": "A String", # API product to be associated with the credential.
"status": "A String", # The API product credential associated status. Valid values are `approved` or `revoked`.
},
],
"attributes": [ # List of attributes associated with the 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", # Immutable. Consumer key.
"consumerSecret": "A String", # Secret key.
"expiresAt": "A String", # Output only. Time the AppGroup app expires in milliseconds since epoch.
"expiresInSeconds": "A String", # Immutable. Expiration time, in seconds, for the consumer key. 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.
"issuedAt": "A String", # Output only. Time the AppGroup app was created in milliseconds since epoch.
"scopes": [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
"A String",
],
"status": "A String", # Status of the credential. Valid values include `approved` or `revoked`.
}</pre>
</div>
</body></html>
|
