blob: 7b33c24fc37c17760dd84f0720af333cba67504c [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">
78 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Deletes a developer app attribute.</p>
80<p class="toc_element">
81 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
82<p class="firstline">Returns a developer app attribute.</p>
83<p class="toc_element">
84 <code><a href="#list">list(parent, x__xgafv=None)</a></code></p>
85<p class="firstline">Returns a list of all developer app attributes.</p>
86<p class="toc_element">
87 <code><a href="#updateDeveloperAppAttribute">updateDeveloperAppAttribute(name, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Updates a developer app attribute.</p>
89<h3>Method Details</h3>
90<div class="method">
91 <code class="details" id="delete">delete(name, x__xgafv=None)</code>
92 <pre>Deletes a developer app attribute.
93
94Args:
95 name: string, Required. Name of the developer app attribute. Use the following structure in your
96request:
97 `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (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 { # Key-value pair to store extra metadata.
107 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
108 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
109 }</pre>
110</div>
111
112<div class="method">
113 <code class="details" id="get">get(name, x__xgafv=None)</code>
114 <pre>Returns a developer app attribute.
115
116Args:
117 name: string, Required. Name of the developer app attribute. Use the following structure in your
118request:
119 `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (required)
120 x__xgafv: string, V1 error format.
121 Allowed values
122 1 - v1 error format
123 2 - v2 error format
124
125Returns:
126 An object of the form:
127
128 { # Key-value pair to store extra metadata.
129 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
130 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
131 }</pre>
132</div>
133
134<div class="method">
135 <code class="details" id="list">list(parent, x__xgafv=None)</code>
136 <pre>Returns a list of all developer app attributes.
137
138Args:
139 parent: string, Required. Name of the developer app. Use the following structure in your request:
140 `organizations/{org}/developers/{developer_email}/apps/{app}` (required)
141 x__xgafv: string, V1 error format.
142 Allowed values
143 1 - v1 error format
144 2 - v2 error format
145
146Returns:
147 An object of the form:
148
149 {
150 &quot;attribute&quot;: [ # List of attributes.
151 { # Key-value pair to store extra metadata.
152 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
153 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
154 },
155 ],
156 }</pre>
157</div>
158
159<div class="method">
160 <code class="details" id="updateDeveloperAppAttribute">updateDeveloperAppAttribute(name, body=None, x__xgafv=None)</code>
161 <pre>Updates a developer app attribute.
162
163**Note**: OAuth access tokens and Key Management Service (KMS) entities
164(apps, developers, and API products) are cached for 180 seconds
165(current default). Any custom attributes associated with these entities
166are cached for at least 180 seconds after the entity is accessed at
167runtime. Therefore, an `ExpiresIn` element on the OAuthV2 policy
168won&#x27;t be able to expire an access token in less than 180 seconds.
169
170Args:
171 name: string, Required. Name of the developer app attribute. Use the following structure in your
172request:
173 `organizations/{org}/developers/{developer_email}/apps/{app}/attributes/{attribute}` (required)
174 body: object, The request body.
175 The object takes the form of:
176
177{ # Key-value pair to store extra metadata.
178 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
179 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
180}
181
182 x__xgafv: string, V1 error format.
183 Allowed values
184 1 - v1 error format
185 2 - v2 error format
186
187Returns:
188 An object of the form:
189
190 { # Key-value pair to store extra metadata.
191 &quot;value&quot;: &quot;A String&quot;, # Value of the attribute.
192 &quot;name&quot;: &quot;A String&quot;, # API key of the attribute.
193 }</pre>
194</div>
195
196</body></html>