blob: 30c8f719f1624624e975c561de14d5fb84ce0a81 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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.attributes.html">attributes</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070078 <code><a href="#close">close()</a></code></p>
79<p class="firstline">Close httplib2 connections.</p>
80<p class="toc_element">
Bu Sun Kim65020912020-05-20 12:08:20 -070081 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Deletes a developer app attribute.</p>
83<p class="toc_element">
84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a developer app attribute.</p>
86<p class="toc_element">
87 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
88<p class="firstline">Returns a list of all developer app attributes.</p>
89<p class="toc_element">
90 <code><a href="#updateDeveloperAppAttribute">updateDeveloperAppAttribute(name, body=None, x__xgafv=None)</a></code></p>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070091<p class="firstline">Updates a developer app attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won't be able to expire an access token in less than 180 seconds.</p>
Bu Sun Kim65020912020-05-20 12:08:20 -070092<h3>Method Details</h3>
93<div class="method">
Dmitry Frenkel3e17f892020-10-06 16:46:05 -070094 <code class="details" id="close">close()</code>
95 <pre>Close httplib2 connections.</pre>
96</div>
97
98<div class="method">
Bu Sun Kim65020912020-05-20 12:08:20 -070099 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
100 <pre>Deletes a developer app attribute.
101
102Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700103 name: string, Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700104 x__xgafv: string, V1 error format.
105 Allowed values
106 1 - v1 error format
107 2 - v2 error format
108
109Returns:
110 An object of the form:
111
112 { # Key-value pair to store extra metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800113 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
114 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
115}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700116</div>
117
118<div class="method">
119 <code class="details" id="get">get(name, x__xgafv=None)</code>
120 <pre>Returns a developer app attribute.
121
122Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700123 name: string, Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700124 x__xgafv: string, V1 error format.
125 Allowed values
126 1 - v1 error format
127 2 - v2 error format
128
129Returns:
130 An object of the form:
131
132 { # Key-value pair to store extra metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800133 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
134 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
135}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700136</div>
137
138<div class="method">
139 <code class="details" id="list">list(parent, x__xgafv=None)</code>
140 <pre>Returns a list of all developer app attributes.
141
142Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700143 parent: string, Required. Name of the developer app. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 {
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800153 &quot;attribute&quot;: [ # List of attributes.
154 { # Key-value pair to store extra metadata.
155 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
156 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
157 },
158 ],
159}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700160</div>
161
162<div class="method">
163 <code class="details" id="updateDeveloperAppAttribute">updateDeveloperAppAttribute(name, body=None, x__xgafv=None)</code>
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700164 <pre>Updates a developer app attribute. **Note**: OAuth access tokens and Key Management Service (KMS) entities (apps, developers, and API products) are cached for 180 seconds (current default). Any custom attributes associated with these entities are cached for at least 180 seconds after the entity is accessed at runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy won&#x27;t be able to expire an access token in less than 180 seconds.
Bu Sun Kim65020912020-05-20 12:08:20 -0700165
166Args:
Dmitry Frenkel3e17f892020-10-06 16:46:05 -0700167 name: string, Required. Name of the developer app attribute. Use the following structure in your request: `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700168 body: object, The request body.
169 The object takes the form of:
170
171{ # Key-value pair to store extra metadata.
Yoshi Automation Botb6971b02020-11-26 17:16:03 -0800172 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800173 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
Bu Sun Kim65020912020-05-20 12:08:20 -0700174}
175
176 x__xgafv: string, V1 error format.
177 Allowed values
178 1 - v1 error format
179 2 - v2 error format
180
181Returns:
182 An object of the form:
183
184 { # Key-value pair to store extra metadata.
Yoshi Automation Botcc94ec82021-01-15 07:10:04 -0800185 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
186 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
187}</pre>
Bu Sun Kim65020912020-05-20 12:08:20 -0700188</div>
189
190</body></html>