@rockcarver/frodo-lib

Version:

A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.

34 lines (33 loc) • 36.9 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>User | 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.User.html">User</a></li></ul><h1>Type Alias User</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">User</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createUserExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createUserGroupExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</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="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportUserGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</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="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportUserGroups</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.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportUsers</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.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importUserGroups</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.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">groupId</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</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">importUsers</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.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">userId</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.UserExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserExportSkeleton</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">readUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</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.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readUserGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readUserGroups</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</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">readUsers</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.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">createUserExportTemplate</span><a id="__typecreateuserexporttemplate" 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="__typecreateuserexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createUserExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><a href="#__typecreateuserexporttemplate-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 user export template</p> </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a></h4><p>an empty user 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/UserOps.ts#L30">ops/UserOps.ts:30</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createUserGroupExportTemplate</span><a id="__typecreateusergroupexporttemplate" 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="__typecreateusergroupexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createUserGroupExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><a href="#__typecreateusergroupexporttemplate-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 user group export template</p> </div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a></h4><p>an empty user group 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/UserOps.ts#L57">ops/UserOps.ts:57</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportUser</span><a id="__typeexportuser" 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="__typeexportuser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</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="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportuser-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 user 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">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>User 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="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a UserExportInterface 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/UserOps.ts#L47">ops/UserOps.ts:47</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportUserGroup</span><a id="__typeexportusergroup" 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="__typeexportusergroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportUserGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</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="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportusergroup-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 user group 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">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Group 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="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a UserGroupExportInterface 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/UserOps.ts#L74">ops/UserOps.ts:74</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportUserGroups</span><a id="__typeexportusergroups" 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="__typeexportusergroups-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportUserGroups</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.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportusergroups-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 user groups. The response can be saved to file as is.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a UserGroupExportInterface 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/UserOps.ts#L79">ops/UserOps.ts:79</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportUsers</span><a id="__typeexportusers" 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="__typeexportusers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportUsers</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.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportusers-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 users. The response can be saved to file as is.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a UserExportInterface 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/UserOps.ts#L52">ops/UserOps.ts:52</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importUserGroups</span><a id="__typeimportusergroups" 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="__typeimportusergroups-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importUserGroups</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.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">groupId</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportusergroups-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 user groups</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.UserGroupExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserGroupExportInterface</a></span><div class="tsd-comment tsd-typography"><p>user group 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">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional user group id. If supplied, only the group 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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>the imported user groups</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/UserOps.ts#L96">ops/UserOps.ts:96</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importUsers</span><a id="__typeimportusers" 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="__typeimportusers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importUsers</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.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">userId</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.UserExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserExportSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportusers-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 users and their config</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.UserExportInterface.html" class="tsd-signature-type tsd-kind-interface">UserExportInterface</a></span><div class="tsd-comment tsd-typography"><p>user 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">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Optional user id. If supplied, only the user 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.UserExportSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserExportSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>the imported users</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/UserOps.ts#L86">ops/UserOps.ts:86</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readUser</span><a id="__typereaduser" 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="__typereaduser-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readUser</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">userId</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.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereaduser-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 user 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">userId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>User 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.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a user 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/UserOps.ts#L36">ops/UserOps.ts:36</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readUserGroup</span><a id="__typereadusergroup" 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="__typereadusergroup-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readUserGroup</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadusergroup-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 user group 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">groupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Group 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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a user group 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/UserOps.ts#L63">ops/UserOps.ts:63</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readUserGroups</span><a id="__typereadusergroups" 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="__typereadusergroups-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readUserGroups</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.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadusergroups-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 user groups.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.UserGroupSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserGroupSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of user group 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/UserOps.ts#L68">ops/UserOps.ts:68</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readUsers</span><a id="__typereadusers" 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="__typereadusers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readUsers</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.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadusers-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 users.</p> </div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.UserSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">UserSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of user 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/UserOps.ts#L41">ops/UserOps.ts:41</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/UserOps.ts#L25">ops/UserOps.ts:25</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>