@rockcarver/frodo-lib

Version:

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

47 lines • 63.6 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>IdmSystem | 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.IdmSystem.html">IdmSystem</a></li></ul><h1>Type Alias IdmSystem</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">IdmSystem</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">authenticateSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">username</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">password</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">queryAllSystemObjectIds</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">pageCookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</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">querySystemObjects</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">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-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">pageCookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</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">readAvailableSystems</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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</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">readSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSystemSchema</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.ObjectTypeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">ObjectTypeSkeleton</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">readSystemStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">systemName</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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">runSystemScript</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">systemName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">scriptName</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">testConnectorServers</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.ConnectorServerStatusInterface.html" class="tsd-signature-type tsd-kind-interface">ConnectorServerStatusInterface</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">updateSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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">systemObjectData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">failIfExists</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateSystemObjectProperties</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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">operations</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.SystemObjectPatchOperationInterface.html" class="tsd-signature-type tsd-kind-interface">SystemObjectPatchOperationInterface</a><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="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</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">authenticateSystemObject</span><a id="__typeauthenticatesystemobject" 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="__typeauthenticatesystemobject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">authenticateSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">username</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">password</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeauthenticatesystemobject-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>Authenticate a system object using username and password (pass-through authentication)</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">username</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>system object username</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">password</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>system object password</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an IdObjectSkeletonInterface object containing only the _id</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/IdmSystemOps.ts#L48">ops/IdmSystemOps.ts:48</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createSystemObject</span><a id="__typecreatesystemobject" 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="__typecreatesystemobject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><a href="#__typecreatesystemobject-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 system object</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectData</span>: <a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a></span><div class="tsd-comment tsd-typography"><p>system object 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="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an IdObjectSkeletonInterface 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/IdmSystemOps.ts#L114">ops/IdmSystemOps.ts:114</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteSystemObject</span><a id="__typedeletesystemobject" 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="__typedeletesystemobject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><a href="#__typedeletesystemobject-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 system object</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of system object</p> </div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an IdObjectSkeletonInterface 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/IdmSystemOps.ts#L156">ops/IdmSystemOps.ts:156</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">queryAllSystemObjectIds</span><a id="__typequeryallsystemobjectids" 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="__typequeryallsystemobjectids-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">queryAllSystemObjectIds</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">pageCookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#__typequeryallsystemobjectids-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 all system object ids</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>page size (default value: 1000)</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pageCookie</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>paged results cookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of IdObjectSkeletonInterface 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/IdmSystemOps.ts#L69">ops/IdmSystemOps.ts:69</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">querySystemObjects</span><a id="__typequerysystemobjects" 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="__typequerysystemobjects-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">querySystemObjects</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">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-kind-parameter">pageSize</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">pageCookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#__typequerysystemobjects-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 system objects using a search filter</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">filter</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>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><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pageSize</span>: <span class="tsd-signature-type">number</span></span><div class="tsd-comment tsd-typography"><p>page size (default value: 1000)</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">pageCookie</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>paged results cookie</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.PagedResult.html" class="tsd-signature-type tsd-kind-type-alias">PagedResult</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of IdObjectSkeletonInterface 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/IdmSystemOps.ts#L85">ops/IdmSystemOps.ts:85</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readAvailableSystems</span><a id="__typereadavailablesystems" 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="__typereadavailablesystems-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readAvailableSystems</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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadavailablesystems-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 available systems/connectors status</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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an array of system status 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/IdmSystemOps.ts#L34">ops/IdmSystemOps.ts:34</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSystemObject</span><a id="__typereadsystemobject" 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="__typereadsystemobject-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSystemObject</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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">systemObjectType</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">systemObjectId</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="../interfaces/Reference.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span><a href="#__typereadsystemobject-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 system object</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>type of system object</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">systemObjectId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>id of system object</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 (default: <code>['*']</code>)</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.IdObjectSkeletonInterface.html" class="tsd-signature-type tsd-kind-interface">IdObjectSkeletonInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to an IdObjectSkeletonInterface 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/IdmSystemOps.ts#L101">ops/IdmSystemOps.ts:101</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSystemSchema</span><a id="__typereadsystemschema" 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="__typereadsystemschema-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSystemSchema</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">systemName</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><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.ObjectTypeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">ObjectTypeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><a href="#__typereadsystemschema-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 system schema</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</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><span class="tsd-signature-type">Record</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <a href="Reference.ObjectTypeSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">ObjectTypeSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a map of Record<string, ObjectTypeSkeleton></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/IdmSystemOps.ts#L166">ops/IdmSystemOps.ts:166</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readSystemStatus</span><a id="__typereadsystemstatus" 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="__typereadsystemstatus-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readSystemStatus</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">systemName</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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</a><span class="tsd-signature-symbol">></span><a href="#__typereadsystemstatus-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 system/connector status</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">systemName</span>: <span class="tsd-signature-type">string</span></span></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.SystemStatusInterface.html" class="tsd-signature-type tsd-kind-interface">SystemStatusInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise resolving to a system status 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/IdmSystemOps.ts#L39">ops/IdmSystemOps.ts:39</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">runSystemScript</span><a id="__typerunsystemscript" 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="__typerunsystemscript-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">runSystemScript</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">systemName</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">scriptName</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><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#__typerunsystemscript-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>Run system script</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">systemName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of system/connector</p> </div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">scriptName</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>name of script</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><span class="tsd-signature-type">any</span><span class="tsd-signat