@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
43 lines • 57.5 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>InternalRole | 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.InternalRole.html">InternalRole</a></li></ul><h1>Type Alias InternalRole</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">InternalRole</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createInternalRole</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createInternalRoleExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteInternalRoleByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleName</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteInternalRoles</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">exportInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportInternalRoleByName</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportInternalRoles</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importFirstInternalRole</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">importInternalRole</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleId</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importInternalRoleByName</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleName</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importInternalRoles</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">queryInternalRoles</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">readInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readInternalRoleByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleName</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readInternalRoles</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">updateInternalRole</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleId</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">roleData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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">createInternalRole</span><a id="__typecreateinternalrole" 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="__typecreateinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createInternalRole</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreateinternalrole-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 internal role</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">roleData</span>: <a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a></span><div class="tsd-comment tsd-typography"><p>internal role data</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an internal role 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/InternalRoleOps.ts#L42">ops/InternalRoleOps.ts:42</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createInternalRoleExportTemplate</span><a id="__typecreateinternalroleexporttemplate" 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="__typecreateinternalroleexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createInternalRoleExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><a href="#__typecreateinternalroleexporttemplate-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 internal role export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a></h4><p>an empty internal role 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/InternalRoleOps.ts#L36">ops/InternalRoleOps.ts:36</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteInternalRole</span><a id="__typedeleteinternalrole" 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="__typedeleteinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeleteinternalrole-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 internal role</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">roleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role uuid</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an internal role 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/InternalRoleOps.ts#L77">ops/InternalRoleOps.ts:77</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteInternalRoleByName</span><a id="__typedeleteinternalrolebyname" 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="__typedeleteinternalrolebyname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteInternalRoleByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleName</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeleteinternalrolebyname-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 internal role by name</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">roleName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an internal role 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/InternalRoleOps.ts#L83">ops/InternalRoleOps.ts:83</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteInternalRoles</span><a id="__typedeleteinternalroles" 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="__typedeleteinternalroles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteInternalRoles</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typedeleteinternalroles-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 internal roles</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of internal role 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/InternalRoleOps.ts#L88">ops/InternalRoleOps.ts:88</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportInternalRole</span><a id="__typeexportinternalrole" 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="__typeexportinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportinternalrole-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 internal role. 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">roleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role uuid</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an InternalRoleExportInterface 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/InternalRoleOps.ts#L103">ops/InternalRoleOps.ts:103</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportInternalRoleByName</span><a id="__typeexportinternalrolebyname" 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="__typeexportinternalrolebyname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportInternalRoleByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleName</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportinternalrolebyname-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 internal role by name. 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">roleName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an InternalRoleExportInterface 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/InternalRoleOps.ts#L109">ops/InternalRoleOps.ts:109</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportInternalRoles</span><a id="__typeexportinternalroles" 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="__typeexportinternalroles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportInternalRoles</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportinternalroles-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 internal roles. 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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an InternalRoleExportInterface 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/InternalRoleOps.ts#L116">ops/InternalRoleOps.ts:116</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importFirstInternalRole</span><a id="__typeimportfirstinternalrole" 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="__typeimportfirstinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importFirstInternalRole</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportfirstinternalrole-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 internal role. The import data is usually read from an internal role export file.</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a></span><div class="tsd-comment tsd-typography"><p>internal role import data.</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><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/InternalRoleOps.ts#L141">ops/InternalRoleOps.ts:141</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importInternalRole</span><a id="__typeimportinternalrole" 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="__typeimportinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importInternalRole</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleId</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportinternalrole-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 internal role. The import data is usually read from an internal role export file.</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">roleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role uuid</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a></span><div class="tsd-comment tsd-typography"><p>internal role import data.</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an internal role 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/InternalRoleOps.ts#L123">ops/InternalRoleOps.ts:123</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importInternalRoleByName</span><a id="__typeimportinternalrolebyname" 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="__typeimportinternalrolebyname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importInternalRoleByName</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">roleName</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportinternalrolebyname-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 internal role by name. The import data is usually read from an internal role export file.</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">roleName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a></span><div class="tsd-comment tsd-typography"><p>internal role import data.</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an internal role 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/InternalRoleOps.ts#L133">ops/InternalRoleOps.ts:133</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importInternalRoles</span><a id="__typeimportinternalroles" 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="__typeimportinternalroles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importInternalRoles</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportinternalroles-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 internal roles. The import data is usually read from an internal role export file.</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.InternalRoleExportInterface.html" class="tsd-signature-type tsd-kind-interface">InternalRoleExportInterface</a></span><div class="tsd-comment tsd-typography"><p>internal role import data.</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><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/InternalRoleOps.ts#L148">ops/InternalRoleOps.ts:148</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">queryInternalRoles</span><a id="__typequeryinternalroles" 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="__typequeryinternalroles-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryInternalRoles</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">filter</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">fields</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typequeryinternalroles-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>Query internal roles</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">filter</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>CREST search filter</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">fields</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></span><div class="tsd-comment tsd-typography"><p>array of fields to return</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><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/InternalRoleOps.ts#L94">ops/InternalRoleOps.ts:94</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readInternalRole</span><a id="__typereadinternalrole" 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="__typereadinternalrole-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readInternalRole</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleId</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadinternalrole-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 internal role</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">roleId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role uuid</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an internal role 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/InternalRoleOps.ts#L50">ops/InternalRoleOps.ts:50</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readInternalRoleByName</span><a id="__typereadinternalrolebyname" 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="__typereadinternalrolebyname-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readInternalRoleByName</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">roleName</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.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadinternalrolebyname-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 internal role by name</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">roleName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>internal role name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.InternalRoleSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">InternalRoleSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an internal role object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><l