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>GraphqlApiFactory | 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.GraphqlApiFactory.html">GraphqlApiFactory</a></li></ul> <h1>Function GraphqlApiFactory</h1></div> <section class="tsd-panel"> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory"><span class="tsd-kind-call-signature">Graphql<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">adminCreateCustomResolver</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">customResolver</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteCustomResolver</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">customResolverId</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">adminGetAllCustomResolvers</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 ">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">adminGetCustomResolver</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">customResolverId</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetGraphQLConfig</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetGraphQLValidationSettings</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminModifyCustomResolver</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">customResolverId</span>, <span class="tsd-kind-parameter">customResolver</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">adminRunGraphQLOperation</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">adminRunGraphQLOperationRequest</span><span class="tsd-signature-symbol">?</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.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminSetGraphQLValidationSettings</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">graphQLValidationSettings</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">adminUpdateGraphQLConfig</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">graphQLConfig</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="#GraphqlApiFactory" 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>GraphqlApi - 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">adminCreateCustomResolver</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">customResolver</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminDeleteCustomResolver</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">customResolverId</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">adminGetAllCustomResolvers</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 ">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">adminGetCustomResolver</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">customResolverId</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetGraphQLConfig</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminGetGraphQLValidationSettings</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminModifyCustomResolver</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">customResolverId</span>, <span class="tsd-kind-parameter">customResolver</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">adminRunGraphQLOperation</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">adminRunGraphQLOperationRequest</span><span class="tsd-signature-symbol">?</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.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-call-signature">adminSetGraphQLValidationSettings</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">graphQLValidationSettings</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">adminUpdateGraphQLConfig</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">graphQLConfig</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/>Custom<wbr/>Resolver</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminCreateCustomResolver.adminCreateCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Create<wbr/>Custom<wbr/>Resolver</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">customResolver</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminCreateCustomResolver.adminCreateCustomResolver-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 new <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</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">customResolver</span>: <a href="../interfaces/api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a></h5> <div class="tsd-comment tsd-typography"><p>A valid <a href="https://www.mongodb.com/docs/atlas/app-services/reference/config/graphql#std-label-appconfig-custom-resolver">custom resolver configuration</a> 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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Create a custom resolver</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#L11798">src/api.ts:11798</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminDeleteCustomResolver.adminDeleteCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Delete<wbr/>Custom<wbr/>Resolver</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">customResolverId</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="#GraphqlApiFactory.__type.adminDeleteCustomResolver.adminDeleteCustomResolver-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 an existing <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> 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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a custom resolver.</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 custom resolver</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#L11810">src/api.ts:11810</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminGetAllCustomResolvers.adminGetAllCustomResolvers-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>All<wbr/>Custom<wbr/>Resolvers</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminGetAllCustomResolvers.adminGetAllCustomResolvers-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 all <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> configurations from your app's GraphQL API.</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">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 custom resolvers</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#L11821">src/api.ts:11821</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminGetCustomResolver.adminGetCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>Custom<wbr/>Resolver</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">customResolverId</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminGetCustomResolver.adminGetCustomResolver-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/realm/graphql/custom-resolvers/">custom resolver</a> 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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a custom resolver.</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.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get a custom resolver</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#L11833">src/api.ts:11833</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>GraphQLConfig</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminGetGraphQLConfig.adminGetGraphQLConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>GraphQLConfig</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminGetGraphQLConfig.adminGetGraphQLConfig-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 your app's <a href="https://www.mongodb.com/docs/atlas/app-services/graphql/">GraphQL API</a> 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><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.GraphQLConfig.html" class="tsd-signature-type tsd-kind-interface">GraphQLConfig</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get GraphQL API Configuration</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#L11844">src/api.ts:11844</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminGetGraphQLValidationSettings.adminGetGraphQLValidationSettings-1"><span class="tsd-kind-call-signature">admin<wbr/>Get<wbr/>GraphQLValidation<wbr/>Settings</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 ">AxiosPromise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminGetGraphQLValidationSettings.adminGetGraphQLValidationSettings-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 validation level and action for reads and writes.</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">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.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Get validation settings</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#L11855">src/api.ts:11855</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminModifyCustomResolver.adminModifyCustomResolver-1"><span class="tsd-kind-call-signature">admin<wbr/>Modify<wbr/>Custom<wbr/>Resolver</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">customResolverId</span>, <span class="tsd-kind-parameter">customResolver</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="#GraphqlApiFactory.__type.adminModifyCustomResolver.adminModifyCustomResolver-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 an existing <a href="https://www.mongodb.com/docs/realm/graphql/custom-resolvers/">custom resolver</a> 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">customResolverId</span>: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"><p>The unique `_id` value of a custom resolver.</p> </div> <div class="tsd-comment tsd-typography"></div></li> <li> <h5><span class="tsd-kind-parameter">customResolver</span>: <a href="../interfaces/api.CustomResolver.html" class="tsd-signature-type tsd-kind-interface">CustomResolver</a></h5> <div class="tsd-comment tsd-typography"><p>A valid, updated <a href="https://www.mongodb.com/docs/atlas/app-services/reference/config/graphql#std-label-appconfig-custom-resolver">custom resolver configuration</a> 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>Modify a custom resolver</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#L11868">src/api.ts:11868</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Run<wbr/>GraphQLOperation</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminRunGraphQLOperation.adminRunGraphQLOperation-1"><span class="tsd-kind-call-signature">admin<wbr/>Run<wbr/>GraphQLOperation</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">adminRunGraphQLOperationRequest</span><span class="tsd-signature-symbol">?</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.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">></span><a href="#GraphqlApiFactory.__type.adminRunGraphQLOperation.adminRunGraphQLOperation-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>Run a query or mutation as a system user that bypasses authentication and data access rules. You can access metadata about your API, including its schema, with an <a href="https://graphql.org/learn/introspection/">introspection</a> query.</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">adminRunGraphQLOperationRequest</span>: <a href="../interfaces/api.AdminRunGraphQLOperationRequest.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperationRequest</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">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.AdminRunGraphQLOperation200Response.html" class="tsd-signature-type tsd-kind-interface">AdminRunGraphQLOperation200Response</a><span class="tsd-signature-symbol">></span></h4> <div class="tsd-comment tsd-typography"> <h4>Summary</h4><p>Run a query or mutation</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#L11880">src/api.ts:11880</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminSetGraphQLValidationSettings.adminSetGraphQLValidationSettings-1"><span class="tsd-kind-call-signature">admin<wbr/>Set<wbr/>GraphQLValidation<wbr/>Settings</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">graphQLValidationSettings</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="#GraphqlApiFactory.__type.adminSetGraphQLValidationSettings.adminSetGraphQLValidationSettings-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 validation level and action for reads and writes.</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">graphQLValidationSettings</span>: <a href="../interfaces/api.GraphQLValidationSettings.html" class="tsd-signature-type tsd-kind-interface">GraphQLValidationSettings</a></h5> <div class="tsd-comment tsd-typography"><p>The updated validation levels and actions.</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>Modify validation settings</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#L11892">src/api.ts:11892</a></li></ul></aside></li></ul></li> <li class="tsd-parameter"> <h5><span class="tsd-kind-method">admin<wbr/>Update<wbr/>GraphQLConfig</span><span class="tsd-signature-symbol">:</span>function</h5> <ul class="tsd-signatures"> <li class="tsd-signature tsd-anchor-link" id="GraphqlApiFactory.__type.adminUpdateGraphQLConfig.adminUpdateGraphQLConfig-1"><span class="tsd-kind-call-signature">admin<wbr/>Update<wbr/>GraphQLConfig</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">graphQLConfig</span>, <span class="tsd-kind-parameter">options