atlas-app-services-admin-api

<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>RulesApiFactory | atlas-app-services-admin-api</title><meta name="description" content="Documentation for atlas-app-services-admin-api"/><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/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os"</script><header class="tsd-page-toolbar"> <div class="tsd-toolbar-contents container"> <div class="table-cell" id="tsd-search" data-base=".."> <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"><use href="#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div> <div class="field"> <div id="tsd-toolbar-links"></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">atlas-app-services-admin-api</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"><use href="#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="../index.html">atlas-app-services-admin-api</a></li> <li><a href="../modules/api.html">api</a></li> <li><a href="api.RulesApiFactory.html">RulesApiFactory</a></li></ul> <h1>Function RulesApiFactory</h1></div> <section class="tsd-panel"> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory"><span class="tsd-kind-call-signature">Rules<wbr/>Api<wbr/>Factory</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">configuration</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">basePath</span><span class="tsd-signature-symbol">?</span>, <span class="tsd-kind-parameter">axios</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">adminCreateDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">defaultRule</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminCreateRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateRule201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateRule201Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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> </span><span class="tsd-kind-call-signature">adminListRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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> </span><span class="tsd-kind-call-signature">adminUpdateDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminUpdateRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span><a href="#RulesApiFactory" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>RulesApi - factory interface</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">configuration</span>: <a href="../classes/configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></h5></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span></h5></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type ">AxiosInstance</span></h5></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-call-signature">adminCreateDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">defaultRule</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminCreateRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateRule201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateRule201Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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> </span><span class="tsd-kind-call-signature">adminListRules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</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> </span><span class="tsd-kind-call-signature">adminUpdateDefaultRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminUpdateRule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol"> => </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></h4> <ul class="tsd-parameters"> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Create<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminCreateDefaultRule.adminCreateDefaultRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">defaultRule</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminCreateDefaultRule.adminCreateDefaultRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Create <a href="https://www.mongodb.com/docs/atlas/app-services/rules/#default-rules">default roles and filters</a> for a data source.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">defaultRule</span>: <a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a></h5> <div class="tsd-comment tsd-typography"><p>A default rule configuration object.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Create default roles and filters</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15364">src/api.ts:15364</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Create<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminCreateRule.adminCreateRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateRule201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateRule201Response</a><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminCreateRule.adminCreateRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Create a <a href="https://www.mongodb.com/docs/atlas/app-services/rules">data access rule</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The rule to create.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.AdminCreateRule201Response.html" class="tsd-signature-type tsd-kind-interface">AdminCreateRule201Response</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Create a rule</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15377">src/api.ts:15377</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Delete<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminDeleteDefaultRule.adminDeleteDefaultRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminDeleteDefaultRule.adminDeleteDefaultRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Delete the <a href="https://www.mongodb.com/docs/atlas/app-services/rules/#default-rules">default roles and filters</a> of a data source.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Delete default roles and filters</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15389">src/api.ts:15389</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Delete<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminDeleteRule.adminDeleteRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminDeleteRule.adminDeleteRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Delete a <a href="https://www.mongodb.com/docs/atlas/app-services/rules">data access rule</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">ruleId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a rule.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Delete a rule</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15402">src/api.ts:15402</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminGetDefaultRule.adminGetDefaultRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminGetDefaultRule.adminGetDefaultRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Get the current <a href="https://www.mongodb.com/docs/atlas/app-services/rules/#default-rules">default roles and filters</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.DefaultRule.html" class="tsd-signature-type tsd-kind-interface">DefaultRule</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get default roles and filters</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15414">src/api.ts:15414</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminGetRule.adminGetRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminGetRule.adminGetRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Get a specific <a href="https://www.mongodb.com/docs/atlas/app-services/rules">data access rule</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">ruleId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a rule.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get a rule</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15427">src/api.ts:15427</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>List<wbr/>Rules</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminListRules.adminListRules-1"><span class="tsd-kind-call-signature">admin<wbr/>List<wbr/>Rules</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminListRules.adminListRules-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>List all <a href="https://www.mongodb.com/docs/atlas/app-services/rules">data access rules</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get all rules</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15439">src/api.ts:15439</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Update<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminUpdateDefaultRule.adminUpdateDefaultRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>Default<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminUpdateDefaultRule.adminUpdateDefaultRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Modify the <a href="https://www.mongodb.com/docs/atlas/app-services/rules/#default-rules">default roles and filters</a> of a data source.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The updated default rule configuration object.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Update default roles and filters</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15452">src/api.ts:15452</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Update<wbr/>Rule</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="RulesApiFactory.__type.adminUpdateRule.adminUpdateRule-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>Rule</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">groupId</span>, <span class="tsd-kind-parameter">appId</span>, <span class="tsd-kind-parameter">serviceId</span>, <span class="tsd-kind-parameter">ruleId</span>, <span class="tsd-kind-parameter">body</span>, <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span><a href="#RulesApiFactory.__type.adminUpdateRule.adminUpdateRule-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li> <li class="tsd-description"> <div class="tsd-comment tsd-typography"><p>Update a <a href="https://www.mongodb.com/docs/atlas/app-services/rules">data access rule</a>.</p> </div> <div class="tsd-parameters"> <h4 class="tsd-parameters-title">Parameters</h4> <ul class="tsd-parameter-list"> <li> <h5><span class="tsd-kind-parameter">groupId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>An Atlas <a href="https://docs.atlas.mongodb.com/tutorial/manage-projects/">Project/Group ID</a>.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">appId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The ObjectID of your application. <a href="#section/Project-and-Application-IDs">The App Services API Project and Application IDs section</a> demonstrates how to find this value.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">serviceId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a service.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">ruleId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a rule.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">body</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The new state of the rule.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>Override http request option.</p> </div> <div class="tsd-comment tsd-typography"></div></li></ul></div> <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Update a rule</p> <h4>Throws</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15466">src/api.ts:15466</a></li></ul></aside></li></ul></li></ul> <div class="tsd-comment tsd-typography"> <h4>Export</h4></div><aside class="tsd-sources"> <ul> <li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L15351">src/api.ts:15351</a></li></ul></aside></li></ul></section></div> <div class="col-sidebar"> <div class="page-menu"> <div class="tsd-navigation settings"> <details class="tsd-index-accordion"><summary class="tsd-accordion-summary"> <h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="#icon-chevronDown"></use></svg>Settings</h3></summary> <div class="tsd-accordion-details"> <div class="tsd-filter-visibility"> <h4 class="uppercase">Member Visibility</h4><form> <ul id="tsd-filter-options"> <li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-