@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
25 lines (20 loc) • 12.4 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>frodo | 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="frodo.html">frodo</a></li></ul><h1>Variable frodo<code class="tsd-tag">Const</code></h1></div><div class="tsd-signature"><span class="tsd-kind-variable">frodo</span><span class="tsd-signature-symbol">:</span> <a href="../types/Reference.Frodo.html" class="tsd-signature-type tsd-kind-type-alias">Frodo</a><span class="tsd-signature-symbol"> = ...</span></div><div class="tsd-comment tsd-typography"><p>Default frodo instance</p>
</div><div class="tsd-comment tsd-typography"><div class="tsd-tag-remarks"><h4 class="tsd-anchor-link"><a id="remarks" class="tsd-anchor"></a>Remarks<a href="#remarks" 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>If your application requires a single connection to a ForgeRock Identity Platform
instance at a time, then this default instance is all you need:</p>
<p>In order to use the default <a href="../types/Reference.Frodo.html" class="tsd-kind-type-alias">frodo</a> instance, you must populate its <a href="../types/Reference.State.html" class="tsd-kind-type-alias">state</a> with the
minimum required information to login to your ForgeRock Identity Platform instance:</p>
<pre><code class="javascript"><span class="hl-2">// configure the state before invoking any library functions that require credentials</span><br/><span class="hl-3">state</span><span class="hl-0">.</span><span class="hl-7">setHost</span><span class="hl-0">(</span><span class="hl-4">'https://instance0/am'</span><span class="hl-0">);</span><br/><span class="hl-3">state</span><span class="hl-0">.</span><span class="hl-7">setUsername</span><span class="hl-0">(</span><span class="hl-4">'admin'</span><span class="hl-0">);</span><br/><span class="hl-3">state</span><span class="hl-0">.</span><span class="hl-7">setPassword</span><span class="hl-0">(</span><span class="hl-4">'p@ssw0rd!'</span><span class="hl-0">);</span><br/><br/><span class="hl-2">// now the library can login</span><br/><span class="hl-3">frodo</span><span class="hl-0">.</span><span class="hl-3">login</span><span class="hl-0">.</span><span class="hl-7">getTokens</span><span class="hl-0">();</span><br/><br/><span class="hl-2">// and perform operations</span><br/><span class="hl-3">frodo</span><span class="hl-0">.</span><span class="hl-3">authn</span><span class="hl-0">.</span><span class="hl-3">journey</span><span class="hl-0">.</span><span class="hl-7">exportJourney</span><span class="hl-0">(</span><span class="hl-4">'Login'</span><span class="hl-0">);</span>
</code><button type="button">Copy</button></pre>
<p>If your application needs to connect to multiple ForgeRock Identity Platform instances
simultaneously, then you will want to create additional frodo instances using any of
the available factory methods accessible from the default instance:</p>
<p><a href="../types/Reference.Frodo.html#__typecreateinstance" class="tsd-kind-method">frodo.createInstance</a></p>
<pre><code class="javascript"><span class="hl-2">// use factory method to create a new Frodo instance</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">instance1</span><span class="hl-0"> = </span><span class="hl-3">frodo</span><span class="hl-0">.</span><span class="hl-7">createInstance</span><span class="hl-0">({</span><br/><span class="hl-0"> </span><span class="hl-3">host:</span><span class="hl-0"> </span><span class="hl-4">'https://instance1/am'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">username:</span><span class="hl-0"> </span><span class="hl-4">'admin'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-3">password:</span><span class="hl-0"> </span><span class="hl-4">'p@ssw0rd!'</span><span class="hl-0">,</span><br/><span class="hl-0">});</span><br/><br/><span class="hl-2">// now the instance can login</span><br/><span class="hl-3">instance1</span><span class="hl-0">.</span><span class="hl-3">login</span><span class="hl-0">.</span><span class="hl-7">getTokens</span><span class="hl-0">();</span><br/><br/><span class="hl-2">// and perform operations</span><br/><span class="hl-3">instance1</span><span class="hl-0">.</span><span class="hl-3">authn</span><span class="hl-0">.</span><span class="hl-3">journey</span><span class="hl-0">.</span><span class="hl-7">exportJourney</span><span class="hl-0">(</span><span class="hl-4">'Login'</span><span class="hl-0">);</span>
</code><button type="button">Copy</button></pre>
<p><a href="../types/Reference.Frodo.html#__typecreateinstancewithadminaccount" class="tsd-kind-method">frodo.createInstanceWithAdminAccount</a></p>
<pre><code class="javascript"><span class="hl-2">// use factory method to create a new Frodo instance ready to login with an admin user account</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">instance2</span><span class="hl-0"> = </span><span class="hl-3">frodo</span><span class="hl-0">.</span><span class="hl-7">createInstanceWithAdminAccount</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-4">'https://instance2/am'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">'admin'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">'p@ssw0rd!'</span><br/><span class="hl-0">);</span><br/><br/><span class="hl-2">// now the instance can login</span><br/><span class="hl-3">instance2</span><span class="hl-0">.</span><span class="hl-3">login</span><span class="hl-0">.</span><span class="hl-7">getTokens</span><span class="hl-0">();</span><br/><br/><span class="hl-2">// and perform operations</span><br/><span class="hl-3">instance2</span><span class="hl-0">.</span><span class="hl-3">authn</span><span class="hl-0">.</span><span class="hl-3">journey</span><span class="hl-0">.</span><span class="hl-7">exportJourney</span><span class="hl-0">(</span><span class="hl-4">'Login'</span><span class="hl-0">);</span>
</code><button type="button">Copy</button></pre>
<p><a href="../types/Reference.Frodo.html#__typecreateinstancewithserviceaccount" class="tsd-kind-method">frodo.createInstanceWithServiceAccount</a></p>
<pre><code class="javascript"><span class="hl-2">// use factory method to create a new Frodo instance ready to login with a service account</span><br/><span class="hl-5">const</span><span class="hl-0"> </span><span class="hl-6">instance3</span><span class="hl-0"> = </span><span class="hl-3">frodo</span><span class="hl-0">.</span><span class="hl-7">createInstanceWithServiceAccount</span><span class="hl-0">(</span><br/><span class="hl-0"> </span><span class="hl-4">'https://instance3/am'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">'serviceAccount'</span><span class="hl-0">,</span><br/><span class="hl-0"> </span><span class="hl-4">'{"k":"jwk"}'</span><br/><span class="hl-0">);</span><br/><br/><span class="hl-2">// now the instance can login</span><br/><span class="hl-3">instance3</span><span class="hl-0">.</span><span class="hl-3">login</span><span class="hl-0">.</span><span class="hl-7">getTokens</span><span class="hl-0">();</span><br/><br/><span class="hl-2">// and perform operations</span><br/><span class="hl-3">instance3</span><span class="hl-0">.</span><span class="hl-3">authn</span><span class="hl-0">.</span><span class="hl-3">journey</span><span class="hl-0">.</span><span class="hl-7">exportJourney</span><span class="hl-0">(</span><span class="hl-4">'Login'</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/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/lib/FrodoLib.ts#L524">lib/FrodoLib.ts:524</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>