• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5  margin: 0;
6  padding: 0;
7  border: 0;
8  font-weight: inherit;
9  font-style: inherit;
10  font-size: 100%;
11  font-family: inherit;
12  vertical-align: baseline;
13}
14
15body {
16  font-size: 13px;
17  padding: 1em;
18}
19
20h1 {
21  font-size: 26px;
22  margin-bottom: 1em;
23}
24
25h2 {
26  font-size: 24px;
27  margin-bottom: 1em;
28}
29
30h3 {
31  font-size: 20px;
32  margin-bottom: 1em;
33  margin-top: 1em;
34}
35
36pre, code {
37  line-height: 1.5;
38  font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42  margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46  font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50  border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54  margin-top: 0.5em;
55}
56
57.firstline {
58  margin-left: 2 em;
59}
60
61.method  {
62  margin-top: 1em;
63  border: solid 1px #CCC;
64  padding: 1em;
65  background: #EEE;
66}
67
68.details {
69  font-weight: bold;
70  font-size: 14px;
71}
72
73</style>
74
75<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> . <a href="apigee_v1.organizations.developers.apps.keys.html">keys</a> . <a href="apigee_v1.organizations.developers.apps.keys.apiproducts.html">apiproducts</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78  <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
81  <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Removes an API product from an app's consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product.</p>
83<p class="toc_element">
84  <code><a href="#updateDeveloperAppKeyApiProduct">updateDeveloperAppKeyApiProduct(name, action=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to `revoked` will not allow access to the API.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="close">close()</code>
89  <pre>Close httplib2 connections.</pre>
90</div>
91
92<div class="method">
93    <code class="details" id="delete">delete(name, x__xgafv=None)</code>
94  <pre>Removes an API product from an app&#x27;s consumer key. After the API product is removed, the app cannot access the API resources defined in that API product. **Note**: The consumer key is not removed, only its association with the API product.
95
96Args:
97  name: string, Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}` (required)
98  x__xgafv: string, V1 error format.
99    Allowed values
100      1 - v1 error format
101      2 - v2 error format
102
103Returns:
104  An object of the form:
105
106    {
107  &quot;apiProducts&quot;: [ # List of API products for which the credential can be used. **Note**: Do not specify the list of API products when creating a consumer key and secret for a developer app. Instead, use the UpdateDeveloperAppKey API to make the association after the consumer key and secret are created.
108    &quot;&quot;,
109  ],
110  &quot;attributes&quot;: [ # List of attributes associated with the credential.
111    { # Key-value pair to store extra metadata.
112      &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
113      &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
114    },
115  ],
116  &quot;consumerKey&quot;: &quot;A String&quot;, # Consumer key.
117  &quot;consumerSecret&quot;: &quot;A String&quot;, # Secret key.
118  &quot;expiresAt&quot;: &quot;A String&quot;, # Time the developer app expires in milliseconds since epoch.
119  &quot;expiresInSeconds&quot;: &quot;A String&quot;, # Input only. 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&#x27;t be updated after it is set.
120  &quot;issuedAt&quot;: &quot;A String&quot;, # Time the developer app was created in milliseconds since epoch.
121  &quot;scopes&quot;: [ # Scopes to apply to the app. The specified scope names must already be defined for the API product that you associate with the app.
122    &quot;A String&quot;,
123  ],
124  &quot;status&quot;: &quot;A String&quot;, # Status of the credential. Valid values include `approved` or `revoked`.
125}</pre>
126</div>
127
128<div class="method">
129    <code class="details" id="updateDeveloperAppKeyApiProduct">updateDeveloperAppKeyApiProduct(name, action=None, x__xgafv=None)</code>
130  <pre>Approves or revokes the consumer key for an API product. After a consumer key is approved, the app can use it to access APIs. A consumer key that is revoked or pending cannot be used to access an API. Any access tokens associated with a revoked consumer key will remain active. However, Apigee checks the status of the consumer key and if set to `revoked` will not allow access to the API.
131
132Args:
133  name: string, Name of the API product in the developer app key in the following format: `organizations/{org}/developers/{developer_email}/apps/{app}/keys/{key}/apiproducts/{apiproduct}` (required)
134  action: string, Approve or revoke the consumer key by setting this value to `approve` or `revoke`, respectively.
135  x__xgafv: string, V1 error format.
136    Allowed values
137      1 - v1 error format
138      2 - v2 error format
139
140Returns:
141  An object of the form:
142
143    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`.
144}</pre>
145</div>
146
147</body></html>