blob: 05efb94c284e4de7e39a56f8aa8e2f3cbdba06b2 [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="secretmanager_v1.html">Secret Manager API</a> . <a href="secretmanager_v1.projects.html">projects</a> . <a href="secretmanager_v1.projects.secrets.html">secrets</a> . <a href="secretmanager_v1.projects.secrets.versions.html">versions</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#access">access(name, x__xgafv=None)</a></code></p>
79<p class="firstline">Accesses a SecretVersion. This call returns the secret data.</p>
80<p class="toc_element">
81 <code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p>
82<p class="firstline">Destroys a SecretVersion.</p>
83<p class="toc_element">
84 <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p>
85<p class="firstline">Disables a SecretVersion.</p>
86<p class="toc_element">
87 <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p>
88<p class="firstline">Enables a SecretVersion.</p>
89<p class="toc_element">
90 <code><a href="#get">get(name, x__xgafv=None)</a></code></p>
91<p class="firstline">Gets metadata for a SecretVersion.</p>
92<p class="toc_element">
Bu Sun Kimd059ad82020-07-22 17:02:09 -070093 <code><a href="#list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070094<p class="firstline">Lists SecretVersions. This call does not return secret</p>
95<p class="toc_element">
96 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
97<p class="firstline">Retrieves the next page of results.</p>
98<h3>Method Details</h3>
99<div class="method">
100 <code class="details" id="access">access(name, x__xgafv=None)</code>
101 <pre>Accesses a SecretVersion. This call returns the secret data.
102
103`projects/*/secrets/*/versions/latest` is an alias to the `latest`
104SecretVersion.
105
106Args:
107 name: string, Required. The resource name of the SecretVersion in the format
108`projects/*/secrets/*/versions/*`. (required)
109 x__xgafv: string, V1 error format.
110 Allowed values
111 1 - v1 error format
112 2 - v2 error format
113
114Returns:
115 An object of the form:
116
117 { # Response message for SecretManagerService.AccessSecretVersion.
118 &quot;name&quot;: &quot;A String&quot;, # The resource name of the SecretVersion in the format
119 # `projects/*/secrets/*/versions/*`.
120 &quot;payload&quot;: { # A secret payload resource in the Secret Manager API. This contains the # Secret payload
121 # sensitive secret payload that is associated with a SecretVersion.
122 &quot;data&quot;: &quot;A String&quot;, # The secret data. Must be no larger than 64KiB.
123 },
124 }</pre>
125</div>
126
127<div class="method">
128 <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code>
129 <pre>Destroys a SecretVersion.
130
131Sets the state of the SecretVersion to
132DESTROYED and irrevocably destroys the
133secret data.
134
135Args:
136 name: string, Required. The resource name of the SecretVersion to destroy in the format
137`projects/*/secrets/*/versions/*`. (required)
138 body: object, The request body.
139 The object takes the form of:
140
141{ # Request message for SecretManagerService.DestroySecretVersion.
142 }
143
144 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 { # A secret version resource in the Secret Manager API.
153 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed.
154 # Only present if state is
155 # DESTROYED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700156 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the SecretVersion in the
157 # format `projects/*/secrets/*/versions/*`.
158 #
159 # SecretVersion IDs in a Secret start at 1 and
160 # are incremented for each subsequent version of the secret.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700161 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
162 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700163 }</pre>
164</div>
165
166<div class="method">
167 <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code>
168 <pre>Disables a SecretVersion.
169
170Sets the state of the SecretVersion to
171DISABLED.
172
173Args:
174 name: string, Required. The resource name of the SecretVersion to disable in the format
175`projects/*/secrets/*/versions/*`. (required)
176 body: object, The request body.
177 The object takes the form of:
178
179{ # Request message for SecretManagerService.DisableSecretVersion.
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 { # A secret version resource in the Secret Manager API.
191 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed.
192 # Only present if state is
193 # DESTROYED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700194 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the SecretVersion in the
195 # format `projects/*/secrets/*/versions/*`.
196 #
197 # SecretVersion IDs in a Secret start at 1 and
198 # are incremented for each subsequent version of the secret.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700199 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
200 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700201 }</pre>
202</div>
203
204<div class="method">
205 <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code>
206 <pre>Enables a SecretVersion.
207
208Sets the state of the SecretVersion to
209ENABLED.
210
211Args:
212 name: string, Required. The resource name of the SecretVersion to enable in the format
213`projects/*/secrets/*/versions/*`. (required)
214 body: object, The request body.
215 The object takes the form of:
216
217{ # Request message for SecretManagerService.EnableSecretVersion.
218 }
219
220 x__xgafv: string, V1 error format.
221 Allowed values
222 1 - v1 error format
223 2 - v2 error format
224
225Returns:
226 An object of the form:
227
228 { # A secret version resource in the Secret Manager API.
229 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed.
230 # Only present if state is
231 # DESTROYED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700232 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the SecretVersion in the
233 # format `projects/*/secrets/*/versions/*`.
234 #
235 # SecretVersion IDs in a Secret start at 1 and
236 # are incremented for each subsequent version of the secret.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700237 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
238 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700239 }</pre>
240</div>
241
242<div class="method">
243 <code class="details" id="get">get(name, x__xgafv=None)</code>
244 <pre>Gets metadata for a SecretVersion.
245
246`projects/*/secrets/*/versions/latest` is an alias to the `latest`
247SecretVersion.
248
249Args:
250 name: string, Required. The resource name of the SecretVersion in the format
251`projects/*/secrets/*/versions/*`.
252`projects/*/secrets/*/versions/latest` is an alias to the `latest`
253SecretVersion. (required)
254 x__xgafv: string, V1 error format.
255 Allowed values
256 1 - v1 error format
257 2 - v2 error format
258
259Returns:
260 An object of the form:
261
262 { # A secret version resource in the Secret Manager API.
263 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed.
264 # Only present if state is
265 # DESTROYED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700266 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the SecretVersion in the
267 # format `projects/*/secrets/*/versions/*`.
268 #
269 # SecretVersion IDs in a Secret start at 1 and
270 # are incremented for each subsequent version of the secret.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700271 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
272 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700273 }</pre>
274</div>
275
276<div class="method">
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700277 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -0700278 <pre>Lists SecretVersions. This call does not return secret
279data.
280
281Args:
282 parent: string, Required. The resource name of the Secret associated with the
283SecretVersions to list, in the format
284`projects/*/secrets/*`. (required)
Bu Sun Kim65020912020-05-20 12:08:20 -0700285 pageSize: integer, Optional. The maximum number of results to be returned in a single page. If
286set to 0, the server decides the number of results to return. If the
287number is greater than 25000, it is capped at 25000.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700288 pageToken: string, Optional. Pagination token, returned earlier via
289ListSecretVersionsResponse.next_page_token][].
Bu Sun Kim65020912020-05-20 12:08:20 -0700290 x__xgafv: string, V1 error format.
291 Allowed values
292 1 - v1 error format
293 2 - v2 error format
294
295Returns:
296 An object of the form:
297
298 { # Response message for SecretManagerService.ListSecretVersions.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700299 &quot;totalSize&quot;: 42, # The total number of SecretVersions.
Bu Sun Kim65020912020-05-20 12:08:20 -0700300 &quot;versions&quot;: [ # The list of SecretVersions sorted in reverse by
301 # create_time (newest first).
302 { # A secret version resource in the Secret Manager API.
303 &quot;destroyTime&quot;: &quot;A String&quot;, # Output only. The time this SecretVersion was destroyed.
304 # Only present if state is
305 # DESTROYED.
Bu Sun Kim65020912020-05-20 12:08:20 -0700306 &quot;name&quot;: &quot;A String&quot;, # Output only. The resource name of the SecretVersion in the
307 # format `projects/*/secrets/*/versions/*`.
308 #
309 # SecretVersion IDs in a Secret start at 1 and
310 # are incremented for each subsequent version of the secret.
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700311 &quot;createTime&quot;: &quot;A String&quot;, # Output only. The time at which the SecretVersion was created.
312 &quot;state&quot;: &quot;A String&quot;, # Output only. The current state of the SecretVersion.
Bu Sun Kim65020912020-05-20 12:08:20 -0700313 },
314 ],
Bu Sun Kimd059ad82020-07-22 17:02:09 -0700315 &quot;nextPageToken&quot;: &quot;A String&quot;, # A token to retrieve the next page of results. Pass this value in
316 # ListSecretVersionsRequest.page_token to retrieve the next page.
Bu Sun Kim65020912020-05-20 12:08:20 -0700317 }</pre>
318</div>
319
320<div class="method">
321 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
322 <pre>Retrieves the next page of results.
323
324Args:
325 previous_request: The request for the previous page. (required)
326 previous_response: The response from the request for the previous page. (required)
327
328Returns:
329 A request object that you can call &#x27;execute()&#x27; on to request the next
330 page. Returns None if there are no more items in the collection.
331 </pre>
332</div>
333
334</body></html>