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="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. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.</p> 80<p class="toc_element"> 81 <code><a href="#close">close()</a></code></p> 82<p class="firstline">Close httplib2 connections.</p> 83<p class="toc_element"> 84 <code><a href="#destroy">destroy(name, body=None, x__xgafv=None)</a></code></p> 85<p class="firstline">Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data.</p> 86<p class="toc_element"> 87 <code><a href="#disable">disable(name, body=None, x__xgafv=None)</a></code></p> 88<p class="firstline">Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED.</p> 89<p class="toc_element"> 90 <code><a href="#enable">enable(name, body=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED.</p> 92<p class="toc_element"> 93 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 94<p class="firstline">Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion.</p> 95<p class="toc_element"> 96 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 97<p class="firstline">Lists SecretVersions. This call does not return secret data.</p> 98<p class="toc_element"> 99 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 100<p class="firstline">Retrieves the next page of results.</p> 101<h3>Method Details</h3> 102<div class="method"> 103 <code class="details" id="access">access(name, x__xgafv=None)</code> 104 <pre>Accesses a SecretVersion. This call returns the secret data. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. 105 106Args: 107 name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required) 108 x__xgafv: string, V1 error format. 109 Allowed values 110 1 - v1 error format 111 2 - v2 error format 112 113Returns: 114 An object of the form: 115 116 { # Response message for SecretManagerService.AccessSecretVersion. 117 "name": "A String", # The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. 118 "payload": { # A secret payload resource in the Secret Manager API. This contains the sensitive secret payload that is associated with a SecretVersion. # Secret payload 119 "data": "A String", # The secret data. Must be no larger than 64KiB. 120 }, 121}</pre> 122</div> 123 124<div class="method"> 125 <code class="details" id="close">close()</code> 126 <pre>Close httplib2 connections.</pre> 127</div> 128 129<div class="method"> 130 <code class="details" id="destroy">destroy(name, body=None, x__xgafv=None)</code> 131 <pre>Destroys a SecretVersion. Sets the state of the SecretVersion to DESTROYED and irrevocably destroys the secret data. 132 133Args: 134 name: string, Required. The resource name of the SecretVersion to destroy in the format `projects/*/secrets/*/versions/*`. (required) 135 body: object, The request body. 136 The object takes the form of: 137 138{ # Request message for SecretManagerService.DestroySecretVersion. 139 "etag": "A String", # Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. 140} 141 142 x__xgafv: string, V1 error format. 143 Allowed values 144 1 - v1 error format 145 2 - v2 error format 146 147Returns: 148 An object of the form: 149 150 { # A secret version resource in the Secret Manager API. 151 "createTime": "A String", # Output only. The time at which the SecretVersion was created. 152 "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. 153 "etag": "A String", # Output only. Etag of the currently stored SecretVersion. 154 "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. 155 "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion. 156 "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. 157 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 158 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 159 }, 160 }, 161 "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. 162 "replicas": [ # Output only. The list of replica statuses for the SecretVersion. 163 { # Describes the status of a user-managed replica for the SecretVersion. 164 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 165 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 166 }, 167 "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`. 168 }, 169 ], 170 }, 171 }, 172 "state": "A String", # Output only. The current state of the SecretVersion. 173}</pre> 174</div> 175 176<div class="method"> 177 <code class="details" id="disable">disable(name, body=None, x__xgafv=None)</code> 178 <pre>Disables a SecretVersion. Sets the state of the SecretVersion to DISABLED. 179 180Args: 181 name: string, Required. The resource name of the SecretVersion to disable in the format `projects/*/secrets/*/versions/*`. (required) 182 body: object, The request body. 183 The object takes the form of: 184 185{ # Request message for SecretManagerService.DisableSecretVersion. 186 "etag": "A String", # Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. 187} 188 189 x__xgafv: string, V1 error format. 190 Allowed values 191 1 - v1 error format 192 2 - v2 error format 193 194Returns: 195 An object of the form: 196 197 { # A secret version resource in the Secret Manager API. 198 "createTime": "A String", # Output only. The time at which the SecretVersion was created. 199 "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. 200 "etag": "A String", # Output only. Etag of the currently stored SecretVersion. 201 "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. 202 "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion. 203 "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. 204 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 205 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 206 }, 207 }, 208 "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. 209 "replicas": [ # Output only. The list of replica statuses for the SecretVersion. 210 { # Describes the status of a user-managed replica for the SecretVersion. 211 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 212 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 213 }, 214 "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`. 215 }, 216 ], 217 }, 218 }, 219 "state": "A String", # Output only. The current state of the SecretVersion. 220}</pre> 221</div> 222 223<div class="method"> 224 <code class="details" id="enable">enable(name, body=None, x__xgafv=None)</code> 225 <pre>Enables a SecretVersion. Sets the state of the SecretVersion to ENABLED. 226 227Args: 228 name: string, Required. The resource name of the SecretVersion to enable in the format `projects/*/secrets/*/versions/*`. (required) 229 body: object, The request body. 230 The object takes the form of: 231 232{ # Request message for SecretManagerService.EnableSecretVersion. 233 "etag": "A String", # Optional. Etag of the SecretVersion. The request succeeds if it matches the etag of the currently stored secret version object. If the etag is omitted, the request succeeds. 234} 235 236 x__xgafv: string, V1 error format. 237 Allowed values 238 1 - v1 error format 239 2 - v2 error format 240 241Returns: 242 An object of the form: 243 244 { # A secret version resource in the Secret Manager API. 245 "createTime": "A String", # Output only. The time at which the SecretVersion was created. 246 "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. 247 "etag": "A String", # Output only. Etag of the currently stored SecretVersion. 248 "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. 249 "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion. 250 "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. 251 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 252 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 253 }, 254 }, 255 "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. 256 "replicas": [ # Output only. The list of replica statuses for the SecretVersion. 257 { # Describes the status of a user-managed replica for the SecretVersion. 258 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 259 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 260 }, 261 "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`. 262 }, 263 ], 264 }, 265 }, 266 "state": "A String", # Output only. The current state of the SecretVersion. 267}</pre> 268</div> 269 270<div class="method"> 271 <code class="details" id="get">get(name, x__xgafv=None)</code> 272 <pre>Gets metadata for a SecretVersion. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. 273 274Args: 275 name: string, Required. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. `projects/*/secrets/*/versions/latest` is an alias to the most recently created SecretVersion. (required) 276 x__xgafv: string, V1 error format. 277 Allowed values 278 1 - v1 error format 279 2 - v2 error format 280 281Returns: 282 An object of the form: 283 284 { # A secret version resource in the Secret Manager API. 285 "createTime": "A String", # Output only. The time at which the SecretVersion was created. 286 "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. 287 "etag": "A String", # Output only. Etag of the currently stored SecretVersion. 288 "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. 289 "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion. 290 "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. 291 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 292 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 293 }, 294 }, 295 "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. 296 "replicas": [ # Output only. The list of replica statuses for the SecretVersion. 297 { # Describes the status of a user-managed replica for the SecretVersion. 298 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 299 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 300 }, 301 "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`. 302 }, 303 ], 304 }, 305 }, 306 "state": "A String", # Output only. The current state of the SecretVersion. 307}</pre> 308</div> 309 310<div class="method"> 311 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 312 <pre>Lists SecretVersions. This call does not return secret data. 313 314Args: 315 parent: string, Required. The resource name of the Secret associated with the SecretVersions to list, in the format `projects/*/secrets/*`. (required) 316 filter: string, Optional. Filter string, adhering to the rules in [List-operation filtering](https://cloud.google.com/secret-manager/docs/filtering). List only secret versions matching the filter. If filter is empty, all secret versions are listed. 317 pageSize: integer, Optional. The maximum number of results to be returned in a single page. If set to 0, the server decides the number of results to return. If the number is greater than 25000, it is capped at 25000. 318 pageToken: string, Optional. Pagination token, returned earlier via ListSecretVersionsResponse.next_page_token][]. 319 x__xgafv: string, V1 error format. 320 Allowed values 321 1 - v1 error format 322 2 - v2 error format 323 324Returns: 325 An object of the form: 326 327 { # Response message for SecretManagerService.ListSecretVersions. 328 "nextPageToken": "A String", # A token to retrieve the next page of results. Pass this value in ListSecretVersionsRequest.page_token to retrieve the next page. 329 "totalSize": 42, # The total number of SecretVersions. 330 "versions": [ # The list of SecretVersions sorted in reverse by create_time (newest first). 331 { # A secret version resource in the Secret Manager API. 332 "createTime": "A String", # Output only. The time at which the SecretVersion was created. 333 "destroyTime": "A String", # Output only. The time this SecretVersion was destroyed. Only present if state is DESTROYED. 334 "etag": "A String", # Output only. Etag of the currently stored SecretVersion. 335 "name": "A String", # Output only. The resource name of the SecretVersion in the format `projects/*/secrets/*/versions/*`. SecretVersion IDs in a Secret start at 1 and are incremented for each subsequent version of the secret. 336 "replicationStatus": { # The replication status of a SecretVersion. # The replication status of the SecretVersion. 337 "automatic": { # The replication status of a SecretVersion using automatic replication. Only populated if the parent Secret has an automatic replication policy. # Describes the replication status of a SecretVersion with automatic replication. Only populated if the parent Secret has an automatic replication policy. 338 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 339 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 340 }, 341 }, 342 "userManaged": { # The replication status of a SecretVersion using user-managed replication. Only populated if the parent Secret has a user-managed replication policy. # Describes the replication status of a SecretVersion with user-managed replication. Only populated if the parent Secret has a user-managed replication policy. 343 "replicas": [ # Output only. The list of replica statuses for the SecretVersion. 344 { # Describes the status of a user-managed replica for the SecretVersion. 345 "customerManagedEncryption": { # Describes the status of customer-managed encryption. # Output only. The customer-managed encryption status of the SecretVersion. Only populated if customer-managed encryption is used. 346 "kmsKeyVersionName": "A String", # Required. The resource name of the Cloud KMS CryptoKeyVersion used to encrypt the secret payload, in the following format: `projects/*/locations/*/keyRings/*/cryptoKeys/*/versions/*`. 347 }, 348 "location": "A String", # Output only. The canonical ID of the replica location. For example: `"us-east1"`. 349 }, 350 ], 351 }, 352 }, 353 "state": "A String", # Output only. The current state of the SecretVersion. 354 }, 355 ], 356}</pre> 357</div> 358 359<div class="method"> 360 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 361 <pre>Retrieves the next page of results. 362 363Args: 364 previous_request: The request for the previous page. (required) 365 previous_response: The response from the request for the previous page. (required) 366 367Returns: 368 A request object that you can call 'execute()' on to request the next 369 page. Returns None if there are no more items in the collection. 370 </pre> 371</div> 372 373</body></html>