@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
40 lines (39 loc) • 108 kB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>Secret | Frodo Library - v3.3.5</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Frodo Library - v3.3.5</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.Secret.html">Secret</a></li></ul><h1>Type Alias Secret</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Secret</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createNewVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useInPlaceholders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteSecret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">disableVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">enableVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">includeActiveValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportSecrets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">includeActiveValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSecret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSecrets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSecretVersions</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">includeActiveValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importSecrets</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">includeActiveValues</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">source</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">putSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useInPlaceholders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSecret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSecrets</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSecretValue</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">decrypt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSecretValues</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretIds</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">decrypt</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-symbol">{</span> <span class="tsd-signature-symbol">[</span><span class="tsd-kind-index-signature">key</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">]:</span> <span class="tsd-signature-type">string</span> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readVersionsOfSecret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">setSecretDescription</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">setStatusOfVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">status</span><span class="tsd-signature-symbol">:</span> <a href="Reference.VersionOfSecretStatus.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretStatus</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateSecretDescription</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">createNewVersionOfSecret</span><a id="__typecreatenewversionofsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatenewversionofsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createNewVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatenewversionofsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create new secret version</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret value</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a version object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v2.0.0 use <a href="Reference.Secret.html#__typecreateversionofsecret" class="tsd-kind-method">createVersionOfSecret</a> instead</p>
<pre><code class="javascript"><span class="hl-7">createVersionOfSecret</span><span class="hl-0">(</span><span class="hl-3">secretId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">value</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">any</span><span class="hl-0">></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L279">ops/cloud/SecretsOps.ts:279</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createSecret</span><a id="__typecreatesecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreatesecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">description</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">encoding</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">useInPlaceholders</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatesecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret value</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">description</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret description</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">encoding</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret encoding (only <code>generic</code> is supported)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">useInPlaceholders</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>flag indicating if the secret can be used in placeholders</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a secret</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L124">ops/cloud/SecretsOps.ts:124</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createVersionOfSecret</span><a id="__typecreateversionofsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreateversionofsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">value</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreateversionofsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create version of secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">value</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret value</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a version object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L156">ops/cloud/SecretsOps.ts:156</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteSecret</span><a id="__typedeletesecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeletesecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteSecret</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeletesecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a secret object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L143">ops/cloud/SecretsOps.ts:143</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteVersionOfSecret</span><a id="__typedeleteversionofsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeleteversionofsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeleteversionofsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete version of secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret version</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a version object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L196">ops/cloud/SecretsOps.ts:196</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">disableVersionOfSecret</span><a id="__typedisableversionofsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedisableversionofsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">disableVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedisableversionofsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Disable a version of a secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret version</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a status object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L186">ops/cloud/SecretsOps.ts:186</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">enableVersionOfSecret</span><a id="__typeenableversionofsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeenableversionofsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">enableVersionOfSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">version</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeenableversionofsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Enable a version of a secret</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">version</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret version</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.VersionOfSecretSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">VersionOfSecretSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a status object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/cloud/SecretsOps.ts#L176">ops/cloud/SecretsOps.ts:176</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportSecret</span><a id="__typeexportsecret" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportsecret-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportSecret</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">includeActiveValue</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">target</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportsecret-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export secret. The response can be saved to file as is.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">secretId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>secret id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">includeActiveValue</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>include active value of secret (default: false)</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">target</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Host URL of target environment to encrypt secret value for</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.SecretsExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretsExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a SecretsExportInterface object.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/71d65bb4fc39e87f46720693e8ef00cca558672