@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
55 lines (52 loc) • 58 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>OAuth2Client | 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.OAuth2Client.html">OAuth2Client</a></li></ul><h1>Type Alias OAuth2Client</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">OAuth2Client</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">clientData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createOAuth2ClientExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteOAuth2Clients</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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">exportOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</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="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportOAuth2Clients</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</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="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getOAuth2Clients</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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">importFirstOAuth2Client</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importOAuth2Clients</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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">putOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">clientData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readOAuth2Clients</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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">updateOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">clientData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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">createOAuth2Client</span><a id="__typecreateoauth2client" 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="__typecreateoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">clientData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreateoauth2client-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 OAuth2 client</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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">clientData</span>: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a></span><div class="tsd-comment tsd-typography"><p>oauth2client object</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an oauth2client 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/OAuth2ClientOps.ts#L51">ops/OAuth2ClientOps.ts:51</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createOAuth2ClientExportTemplate</span><a id="__typecreateoauth2clientexporttemplate" 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="__typecreateoauth2clientexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createOAuth2ClientExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><a href="#__typecreateoauth2clientexporttemplate-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 OAuth2 client export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a></h4><p>an empty OAuth2 client 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/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/OAuth2ClientOps.ts#L33">ops/OAuth2ClientOps.ts:33</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteOAuth2Client</span><a id="__typedeleteoauth2client" 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="__typedeleteoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeleteoauth2client-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 OAuth2 client</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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an oauth2client 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/OAuth2ClientOps.ts#L75">ops/OAuth2ClientOps.ts:75</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteOAuth2Clients</span><a id="__typedeleteoauth2clients" 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="__typedeleteoauth2clients-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteOAuth2Clients</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typedeleteoauth2clients-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 all OAuth2 clients</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of oauth2client 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/71d65bb4fc39e87f46720693e8ef00cca5586721/src/ops/OAuth2ClientOps.ts#L69">ops/OAuth2ClientOps.ts:69</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportOAuth2Client</span><a id="__typeexportoauth2client" 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="__typeexportoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</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="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportoauth2client-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 OAuth2 client 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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>oauth2 client id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>export data</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/OAuth2ClientOps.ts#L90">ops/OAuth2ClientOps.ts:90</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportOAuth2Clients</span><a id="__typeexportoauth2clients" 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="__typeexportoauth2clients-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportOAuth2Clients</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</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="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportoauth2clients-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 OAuth2 clients</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.OAuth2ClientExportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>export data</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/OAuth2ClientOps.ts#L81">ops/OAuth2ClientOps.ts:81</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getOAuth2Client</span><a id="__typegetoauth2client" 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="__typegetoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typegetoauth2client-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>Get OAuth2 client</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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an oauth2client 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.OAuth2Client.html#__typereadoauth2client" class="tsd-kind-method">readOAuth2Client</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readOAuth2Client</span><span class="hl-0">(</span><span class="hl-3">clientId</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">OAuth2ClientSkeleton</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/OAuth2ClientOps.ts#L149">ops/OAuth2ClientOps.ts:149</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getOAuth2Clients</span><a id="__typegetoauth2clients" 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="__typegetoauth2clients-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getOAuth2Clients</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typegetoauth2clients-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>Get all OAuth2 clients</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of oauth2client objects</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-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></h4><p>since v2.0.0 use <a href="Reference.OAuth2Client.html#__typereadoauth2clients" class="tsd-kind-method">readOAuth2Clients</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readOAuth2Clients</span><span class="hl-0">(): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">OAuth2ClientSkeleton</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/OAuth2ClientOps.ts#L138">ops/OAuth2ClientOps.ts:138</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importFirstOAuth2Client</span><a id="__typeimportfirstoauth2client" 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="__typeimportfirstoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importFirstOAuth2Client</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportfirstoauth2client-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 first OAuth2 Client</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an oauth2 client</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/OAuth2ClientOps.ts#L112">ops/OAuth2ClientOps.ts:112</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importOAuth2Client</span><a id="__typeimportoauth2client" 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="__typeimportoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportoauth2client-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 OAuth2 Client 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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an oauth2 client</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/OAuth2ClientOps.ts#L101">ops/OAuth2ClientOps.ts:101</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importOAuth2Clients</span><a id="__typeimportoauth2clients" 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="__typeimportoauth2clients-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importOAuth2Clients</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportoauth2clients-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 OAuth2 Clients</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.OAuth2ClientExportInterface.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.OAuth2ClientImportOptions.html" class="tsd-signature-type tsd-kind-interface">OAuth2ClientImportOptions</a></span><div class="tsd-comment tsd-typography"><p>import options</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of oauth2 clients</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/OAuth2ClientOps.ts#L122">ops/OAuth2ClientOps.ts:122</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">putOAuth2Client</span><a id="__typeputoauth2client" 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="__typeputoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">putOAuth2Client</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">clientId</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">clientData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeputoauth2client-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>Put OAuth2 client</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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">clientData</span>: <a href="Reference.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a></span><div class="tsd-comment tsd-typography"><p>oauth2client object</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an oauth2client object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" 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.OAuth2Client.html#__typeupdateoauth2client" class="tsd-kind-method">updateOAuth2Client</a> or <a href="Reference.OAuth2Client.html#__typecreateoauth2client" class="tsd-kind-method">createOAuth2Client</a> instead</p>
<pre><code class="javascript"><span class="hl-7">updateOAuth2Client</span><span class="hl-0">(</span><span class="hl-3">clientId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">clientData</span><span class="hl-0">: </span><span class="hl-3">OAuth2ClientSkeleton</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">OAuth2ClientSkeleton</span><span class="hl-0">></span><br/><span class="hl-7">createOAuth2Client</span><span class="hl-0">(</span><span class="hl-3">clientId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">clientData</span><span class="hl-0">: </span><span class="hl-3">OAuth2ClientSkeleton</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">OAuth2ClientSkeleton</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/OAuth2ClientOps.ts#L162">ops/OAuth2ClientOps.ts:162</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readOAuth2Client</span><a id="__typereadoauth2client" 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="__typereadoauth2client-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readOAuth2Client</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">clientId</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.OAuth2ClientSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">OAuth2ClientSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadoauth2client-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 OAuth2 client</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">clientId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>client id</p>
</div><div class="tsd-com