atlas-app-services-admin-api
Version:
OpenAPI client for Atlas App Services Admin API
436 lines (428 loc) • 94.5 kB
HTML
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>SecurityApi | 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.SecurityApi.html">SecurityApi</a></li></ul>
<h1>Class SecurityApi</h1></div>
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography"><p>SecurityApi - object-oriented interface</p>
</div>
<div class="tsd-comment tsd-typography">
<h4>Export</h4></div></section>
<section class="tsd-panel tsd-hierarchy">
<h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><a href="base.BaseAPI.html" class="tsd-signature-type tsd-kind-class">BaseAPI</a>
<ul class="tsd-hierarchy">
<li><span class="target">SecurityApi</span></li></ul></li></ul></section>
<section class="tsd-panel">
<h4>Implements</h4>
<ul class="tsd-hierarchy">
<li><a href="../interfaces/api.SecurityApiInterface.html" class="tsd-signature-type tsd-kind-interface">SecurityApiInterface</a></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18204">src/api.ts:18204</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
<h5 class="tsd-index-heading uppercase" role="button" aria-expanded="false" tabIndex=0><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="#icon-chevronSmall"></use></svg> Index</h5></summary>
<div class="tsd-accordion-details">
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Constructors</h3>
<div class="tsd-index-list"><a href="api.SecurityApi.html#constructor" class="tsd-index-link tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-512"></use></svg><span>constructor</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Properties</h3>
<div class="tsd-index-list"><a href="api.SecurityApi.html#axios" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>axios</span></a>
<a href="api.SecurityApi.html#basePath" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>base<wbr/>Path</span></a>
<a href="api.SecurityApi.html#configuration" class="tsd-index-link tsd-is-protected tsd-is-inherited"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-1024"></use></svg><span>configuration</span></a>
</div></section>
<section class="tsd-index-section">
<h3 class="tsd-index-heading">Methods</h3>
<div class="tsd-index-list"><a href="api.SecurityApi.html#adminCreatePrivateEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Create<wbr/>Private<wbr/>Endpoint</span></a>
<a href="api.SecurityApi.html#adminDeletePrivateEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Delete<wbr/>Private<wbr/>Endpoint</span></a>
<a href="api.SecurityApi.html#adminGetPrivateEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Private<wbr/>Endpoint</span></a>
<a href="api.SecurityApi.html#adminGetPrivateEndpoints" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Private<wbr/>Endpoints</span></a>
<a href="api.SecurityApi.html#adminGetRefreshTokenExpiration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Get<wbr/>Refresh<wbr/>Token<wbr/>Expiration</span></a>
<a href="api.SecurityApi.html#adminListAllowedRequestOrigins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>List<wbr/>Allowed<wbr/>Request<wbr/>Origins</span></a>
<a href="api.SecurityApi.html#adminListPrivateEndpointServices" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>List<wbr/>Private<wbr/>Endpoint<wbr/>Services</span></a>
<a href="api.SecurityApi.html#adminSetAllowedRequestOrigins" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Set<wbr/>Allowed<wbr/>Request<wbr/>Origins</span></a>
<a href="api.SecurityApi.html#adminSetRefreshTokenExpiration" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Set<wbr/>Refresh<wbr/>Token<wbr/>Expiration</span></a>
<a href="api.SecurityApi.html#adminUpdatePrivateEndpoint" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>admin<wbr/>Update<wbr/>Private<wbr/>Endpoint</span></a>
<a href="api.SecurityApi.html#allowedIPAccessListCreate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>allowedIPAccess<wbr/>List<wbr/>Create</span></a>
<a href="api.SecurityApi.html#allowedIPAccessListDelete" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>allowedIPAccess<wbr/>List<wbr/>Delete</span></a>
<a href="api.SecurityApi.html#allowedIPAccessListGet" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>allowedIPAccess<wbr/>List<wbr/>Get</span></a>
<a href="api.SecurityApi.html#allowedIPAccessListUpdate" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>allowedIPAccess<wbr/>List<wbr/>Update</span></a>
</div></section></div></details></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-is-inherited"><a id="constructor" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures tsd-is-inherited">
<li class="tsd-signature tsd-anchor-link" id="constructor.new_SecurityApi"><span class="tsd-kind-constructor-signature">new <wbr/>Security<wbr/>Api</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><a href="api.SecurityApi.html" class="tsd-signature-type tsd-kind-class">SecurityApi</a><a href="#constructor.new_SecurityApi" 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-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="configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></h5></li>
<li>
<h5><span class="tsd-kind-parameter">basePath</span>: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></h5></li>
<li>
<h5><span class="tsd-kind-parameter">axios</span>: <span class="tsd-signature-type ">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <a href="api.SecurityApi.html" class="tsd-signature-type tsd-kind-class">SecurityApi</a></h4><aside class="tsd-sources">
<p>Inherited from <a href="base.BaseAPI.html">BaseAPI</a>.<a href="base.BaseAPI.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/base.ts#L53">src/base.ts:53</a></li></ul></aside></li></ul></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="axios" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>axios</span><a href="#axios" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">axios</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type ">AxiosInstance</span><span class="tsd-signature-symbol"> = globalAxios</span></div><aside class="tsd-sources">
<p>Inherited from <a href="base.BaseAPI.html">BaseAPI</a>.<a href="base.BaseAPI.html#axios">axios</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/base.ts#L53">src/base.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="basePath" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>base<wbr/>Path</span><a href="#basePath" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">base<wbr/>Path</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> = BASE_PATH</span></div><aside class="tsd-sources">
<p>Inherited from <a href="base.BaseAPI.html">BaseAPI</a>.<a href="base.BaseAPI.html#basePath">basePath</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/base.ts#L53">src/base.ts:53</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-is-protected tsd-is-inherited"><a id="configuration" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>configuration</span><a href="#configuration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<div class="tsd-signature"><span class="tsd-kind-property">configuration</span><span class="tsd-signature-symbol">:</span> <a href="configuration.Configuration.html" class="tsd-signature-type tsd-kind-class">Configuration</a></div><aside class="tsd-sources">
<p>Inherited from <a href="base.BaseAPI.html">BaseAPI</a>.<a href="base.BaseAPI.html#configuration">configuration</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/base.ts#L51">src/base.ts:51</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member"><a id="adminCreatePrivateEndpoint" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Create<wbr/>Private<wbr/>Endpoint</span><a href="#adminCreatePrivateEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminCreatePrivateEndpoint.adminCreatePrivateEndpoint-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Private<wbr/>Endpoint</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">privateEndpoint</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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><a href="#adminCreatePrivateEndpoint.adminCreatePrivateEndpoint-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>Configure a new private endpoint for the App.</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">privateEndpoint</span>: <a href="../interfaces/api.PrivateEndpoint.html" class="tsd-signature-type tsd-kind-interface">PrivateEndpoint</a></h5>
<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 ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>Create a VPC Private Endpoint</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminCreatePrivateEndpoint">adminCreatePrivateEndpoint</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18215">src/api.ts:18215</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminDeletePrivateEndpoint" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Delete<wbr/>Private<wbr/>Endpoint</span><a href="#adminDeletePrivateEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminDeletePrivateEndpoint.adminDeletePrivateEndpoint-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Private<wbr/>Endpoint</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">privateEndpointId</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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><a href="#adminDeletePrivateEndpoint.adminDeletePrivateEndpoint-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 private endpoint.</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">privateEndpointId</span>: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>The _id ObjectID of a VPC private endpoint.</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 ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>Delete a VPC Private Endpoint</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminDeletePrivateEndpoint">adminDeletePrivateEndpoint</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18229">src/api.ts:18229</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminGetPrivateEndpoint" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Private<wbr/>Endpoint</span><a href="#adminGetPrivateEndpoint" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminGetPrivateEndpoint.adminGetPrivateEndpoint-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Private<wbr/>Endpoint</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">privateEndpointId</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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.PrivateEndpoint.html" class="tsd-signature-type tsd-kind-interface">PrivateEndpoint</a><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><a href="#adminGetPrivateEndpoint.adminGetPrivateEndpoint-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 private endpoint configuration.</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">privateEndpointId</span>: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>The _id ObjectID of a VPC private endpoint.</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 ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.PrivateEndpoint.html" class="tsd-signature-type tsd-kind-interface">PrivateEndpoint</a><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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>Get a VPC Private Endpoint</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminGetPrivateEndpoint">adminGetPrivateEndpoint</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18243">src/api.ts:18243</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminGetPrivateEndpoints" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Private<wbr/>Endpoints</span><a href="#adminGetPrivateEndpoints" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminGetPrivateEndpoints.adminGetPrivateEndpoints-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Private<wbr/>Endpoints</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">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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><a href="#adminGetPrivateEndpoints.adminGetPrivateEndpoints-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 list of all private endpoints configured for the App.</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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>List VPC Private Endpoints</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminGetPrivateEndpoints">adminGetPrivateEndpoints</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18256">src/api.ts:18256</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminGetRefreshTokenExpiration" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Get<wbr/>Refresh<wbr/>Token<wbr/>Expiration</span><a href="#adminGetRefreshTokenExpiration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminGetRefreshTokenExpiration.adminGetRefreshTokenExpiration-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Refresh<wbr/>Token<wbr/>Expiration</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">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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.RefreshTokenExpiration.html" class="tsd-signature-type tsd-kind-interface">RefreshTokenExpiration</a><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><a href="#adminGetRefreshTokenExpiration.adminGetRefreshTokenExpiration-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 expiration time in seconds for user session refresh tokens.</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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.RefreshTokenExpiration.html" class="tsd-signature-type tsd-kind-interface">RefreshTokenExpiration</a><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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>Get User Refresh Token Expiration Time</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminGetRefreshTokenExpiration">adminGetRefreshTokenExpiration</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18269">src/api.ts:18269</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminListAllowedRequestOrigins" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>List<wbr/>Allowed<wbr/>Request<wbr/>Origins</span><a href="#adminListAllowedRequestOrigins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminListAllowedRequestOrigins.adminListAllowedRequestOrigins-1"><span class="tsd-kind-call-signature">admin<wbr/>List<wbr/>Allowed<wbr/>Request<wbr/>Origins</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">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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><a href="#adminListAllowedRequestOrigins.adminListAllowedRequestOrigins-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 the allowed <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">HTTP origins</a> from which App Services should allow requests.</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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>List allowed HTTP origins</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminListAllowedRequestOrigins">adminListAllowedRequestOrigins</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18282">src/api.ts:18282</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminListPrivateEndpointServices" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>List<wbr/>Private<wbr/>Endpoint<wbr/>Services</span><a href="#adminListPrivateEndpointServices" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminListPrivateEndpointServices.adminListPrivateEndpointServices-1"><span class="tsd-kind-call-signature">admin<wbr/>List<wbr/>Private<wbr/>Endpoint<wbr/>Services</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">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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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><a href="#adminListPrivateEndpointServices.adminListPrivateEndpointServices-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 list of all private endpoint services configured for the App.</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><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-parameter">options</span>: <span class="tsd-signature-type ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>List VPC Private Endpoint Services</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminListPrivateEndpointServices">adminListPrivateEndpointServices</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18295">src/api.ts:18295</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminSetAllowedRequestOrigins" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Set<wbr/>Allowed<wbr/>Request<wbr/>Origins</span><a href="#adminSetAllowedRequestOrigins" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminSetAllowedRequestOrigins.adminSetAllowedRequestOrigins-1"><span class="tsd-kind-call-signature">admin<wbr/>Set<wbr/>Allowed<wbr/>Request<wbr/>Origins</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">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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><a href="#adminSetAllowedRequestOrigins.adminSetAllowedRequestOrigins-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>Set the allowed <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">HTTP origins</a> from which App Services should allow requests.</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">body</span>: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography"><p>A list of HTTP origins.</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 ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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></h4>
<div class="tsd-comment tsd-typography">
<h4>Summary</h4><p>Set allowed HTTP origins</p>
<h4>Throws</h4>
<h4>Memberof</h4><p>SecurityApi</p>
</div><aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/api.SecurityApiInterface.html">SecurityApiInterface</a>.<a href="../interfaces/api.SecurityApiInterface.html#adminSetAllowedRequestOrigins">adminSetAllowedRequestOrigins</a></p>
<ul>
<li>Defined in <a href="https://github.com/gfay63/atlas-app-services-admin-api/blob/fb69983/src/api.ts#L18309">src/api.ts:18309</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member"><a id="adminSetRefreshTokenExpiration" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>admin<wbr/>Set<wbr/>Refresh<wbr/>Token<wbr/>Expiration</span><a href="#adminSetRefreshTokenExpiration" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3>
<ul class="tsd-signatures">
<li class="tsd-signature tsd-anchor-link" id="adminSetRefreshTokenExpiration.adminSetRefreshTokenExpiration-1"><span class="tsd-kind-call-signature">admin<wbr/>Set<wbr/>Refresh<wbr/>Token<wbr/>Expiration</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">refreshTokenExpiration</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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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><a href="#adminSetRefreshTokenExpiration.adminSetRefreshTokenExpiration-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>Set the expiration time in seconds for user session refresh tokens.</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">refreshTokenExpiration</span>: <a href="../interfaces/api.RefreshTokenExpiration.html" class="tsd-signature-type tsd-kind-interface">RefreshTokenExpiration</a></h5>
<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 ">AxiosRequestConfig</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></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 ">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type ">AxiosResponse</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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></h4>