@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
38 lines (37 loc) • 40.1 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecretStore | Frodo Library - v3.1.0</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.1.0</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.SecretStore.html">SecretStore</a></li></ul><h1>Type Alias SecretStore</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">SecretStore</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createSecretStoreExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">globalConfig</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="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportSecretStores</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">globalConfig</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="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importSecretStores</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.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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">secretStoreId</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.SecretStoreExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreExportSkeleton</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">readSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">globalConfig</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSecretStoreMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">secretStoreTypeId</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">globalConfig</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</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">readSecretStores</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">globalConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</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">updateSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateSecretStoreMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">secretStoreTypeId</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">secretStoreMappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><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">createSecretStoreExportTemplate</span><a id="__typecreatesecretstoreexporttemplate" 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="__typecreatesecretstoreexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createSecretStoreExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><a href="#__typecreatesecretstoreexporttemplate-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 an empty secret store export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a></h4><p>an empty secret store export template</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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L26">ops/classic/SecretStoreOps.ts:26</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportSecretStore</span><a id="__typeexportsecretstore" 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="__typeexportsecretstore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">globalConfig</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="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportsecretstore-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 a single secret store by id. 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">secretStoreId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if global secret store is the target of the operation, false otherwise. Default: false.</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.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a SecretStoreExportInterface 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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L61">ops/classic/SecretStoreOps.ts:61</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportSecretStores</span><a id="__typeexportsecretstores" 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="__typeexportsecretstores-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportSecretStores</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">globalConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportsecretstores-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 all secret stores. 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">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if global secret stores are the target of the operation, false otherwise. Default: false.</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.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a SecretStoreExportInterface 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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L70">ops/classic/SecretStoreOps.ts:70</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importSecretStores</span><a id="__typeimportsecretstores" 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="__typeimportsecretstores-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importSecretStores</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.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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">secretStoreId</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.SecretStoreExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreExportSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportsecretstores-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>Import secret stores and mappings</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">importData</span>: <a href="../interfaces/Reference.SecretStoreExportInterface.html" class="tsd-signature-type tsd-kind-interface">SecretStoreExportInterface</a></span><div class="tsd-comment tsd-typography"><p>secret store import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if the secret store mapping is global, false otherwise. 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">secretStoreId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>optional secret store id. If supplied, only the secret store of that id is imported.</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.SecretStoreExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreExportSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>the imported secret stores and mappings</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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L104">ops/classic/SecretStoreOps.ts:104</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSecretStore</span><a id="__typereadsecretstore" 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="__typereadsecretstore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">globalConfig</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span><a href="#__typereadsecretstore-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>Read secret store by id</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">secretStoreId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if global secret store is the target of the operation, false otherwise. Default: false.</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.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a secret store 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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L33">ops/classic/SecretStoreOps.ts:33</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSecretStoreMappings</span><a id="__typereadsecretstoremappings" 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="__typereadsecretstoremappings-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSecretStoreMappings</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">secretStoreTypeId</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">globalConfig</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadsecretstoremappings-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>Read secret store mappings</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">secretStoreId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">secretStoreTypeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store type id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if the secret store is global, false otherwise. Default: false.</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of secret store mapping objects</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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L50">ops/classic/SecretStoreOps.ts:50</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSecretStores</span><a id="__typereadsecretstores" 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="__typereadsecretstores-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSecretStores</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">globalConfig</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadsecretstores-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>Read all secret stores.</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">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if global secret stores are the target of the operation, false otherwise. Default: false.</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.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of secret store objects</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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L42">ops/classic/SecretStoreOps.ts:42</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateSecretStore</span><a id="__typeupdatesecretstore" 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="__typeupdatesecretstore-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateSecretStore</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeupdatesecretstore-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>Update secret store</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">secretStoreData</span>: <a href="../interfaces/Reference.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a></span><div class="tsd-comment tsd-typography"><p>secret store to import</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if the secret store is global, false otherwise. Default: false.</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.AmConfigEntityInterface.html" class="tsd-signature-type tsd-kind-interface">AmConfigEntityInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a secret store 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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L79">ops/classic/SecretStoreOps.ts:79</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateSecretStoreMapping</span><a id="__typeupdatesecretstoremapping" 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="__typeupdatesecretstoremapping-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateSecretStoreMapping</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">secretStoreId</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">secretStoreTypeId</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">secretStoreMappingData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">globalConfig</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeupdatesecretstoremapping-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>Update secret store mapping</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">secretStoreId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">secretStoreTypeId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Secret store type id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">secretStoreMappingData</span>: <a href="Reference.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a></span><div class="tsd-comment tsd-typography"><p>secret store mapping to import</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">globalConfig</span>: <span class="tsd-signature-type">boolean</span></span><div class="tsd-comment tsd-typography"><p>true if the secret store mapping is global, false otherwise. Default: false.</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.SecretStoreMappingSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SecretStoreMappingSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a secret store mapping 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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L91">ops/classic/SecretStoreOps.ts:91</a></li></ul></aside></div></li></ul></li></ul></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/classic/SecretStoreOps.ts#L21">ops/classic/SecretStoreOps.ts:21</a></li></ul></aside></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav id="tsd-sidebar-links" class="tsd-navigation"><a href="https://github.com/rockcarver/frodo-lib" class="tsd-nav-link">Project Home</a></nav><nav class="tsd-navigation"><a href="../modules.html">Frodo Library - v3.1.0</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer></footer><div class="overlay"></div></body></html>