@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
52 lines (49 loc) • 53.9 kB
HTML
<!DOCTYPE html><html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>AdminFederation | Frodo Library - v3.1.0</title><meta name="description" content="Documentation for Frodo Library"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><script async src="../assets/hierarchy.js" id="tsd-hierarchy-script"></script></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search"><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"><a href="https://github.com/rockcarver/frodo-lib">Project Home</a></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">Frodo Library - v3.1.0</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-menu"></use></svg></a></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">Frodo Library</a></li><li><a href="../modules/Reference.html">Reference</a></li><li><a href="Reference.AdminFederation.html">AdminFederation</a></li></ul><h1>Type Alias AdminFederation</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">AdminFederation</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createAdminFederationExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">createAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importAdminFederationProviders</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importFirstAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">putProviderByTypeAndId</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">updateAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></div><div class="tsd-type-declaration"><h4>Type declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter"><h5><span class="tsd-kind-method">createAdminFederationExportTemplate</span><a id="__typecreateadminfederationexporttemplate" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreateadminfederationexporttemplate-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createAdminFederationExportTemplate</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><a href="#__typecreateadminfederationexporttemplate-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create an empty idp export template</p>
</div><h4 class="tsd-returns-title">Returns <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a></h4><p>an empty idp export template</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L20">ops/cloud/AdminFederationOps.ts:20</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">createAdminFederationProvider</span><a id="__typecreateadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typecreateadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreateadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Create admin federation provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider type</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">providerData</span>: <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a></span><div class="tsd-comment tsd-typography"><p>social identity provider data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves a social admin federation object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L39">ops/cloud/AdminFederationOps.ts:39</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteAdminFederationProvider</span><a id="__typedeleteadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typedeleteadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeleteadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Delete admin federation provider by id</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>admin federation provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an admin federation provider object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L61">ops/cloud/AdminFederationOps.ts:61</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportAdminFederationProvider</span><a id="__typeexportadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export admin federation provider by id</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a SocialProviderExportInterface object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L67">ops/cloud/AdminFederationOps.ts:67</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportAdminFederationProviders</span><a id="__typeexportadminfederationproviders" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeexportadminfederationproviders-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportadminfederationproviders-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Export all providers</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a SocialProviderExportInterface object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L74">ops/cloud/AdminFederationOps.ts:74</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getAdminFederationProvider</span><a id="__typegetadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typegetadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get admin federation provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves a social admin federation object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated" class="tsd-anchor"></a>Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v2.0.0 use <a href="Reference.AdminFederation.html#__typereadadminfederationprovider" class="tsd-kind-method">readAdminFederationProvider</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readAdminFederationProvider</span><span class="hl-0">(</span><span class="hl-3">providerId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">SocialIdpSkeleton</span><span class="hl-0">></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L121">ops/cloud/AdminFederationOps.ts:121</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getAdminFederationProviders</span><a id="__typegetadminfederationproviders" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typegetadminfederationproviders-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typegetadminfederationproviders-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Get all admin federation providers</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an object containing an array of admin federation providers</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-1" class="tsd-anchor"></a>Deprecated<a href="#deprecated-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v2.0.0 use <a href="Reference.AdminFederation.html#__typereadadminfederationproviders" class="tsd-kind-method">readAdminFederationProviders</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readAdminFederationProviders</span><span class="hl-0">(): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">SocialIdpSkeleton</span><span class="hl-0">[]></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L110">ops/cloud/AdminFederationOps.ts:110</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importAdminFederationProvider</span><a id="__typeimportadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import admin federation provider by id/name</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L80">ops/cloud/AdminFederationOps.ts:80</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importAdminFederationProviders</span><a id="__typeimportadminfederationproviders" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportadminfederationproviders-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importAdminFederationProviders</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typeimportadminfederationproviders-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import all providers</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L95">ops/cloud/AdminFederationOps.ts:95</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importFirstAdminFederationProvider</span><a id="__typeimportfirstadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeimportfirstadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importFirstAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">importData</span><span class="tsd-signature-symbol">:</span> <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportfirstadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Import first provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.AdminFederationExportInterface.html" class="tsd-signature-type tsd-kind-interface">AdminFederationExportInterface</a></span><div class="tsd-comment tsd-typography"><p>import data</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L88">ops/cloud/AdminFederationOps.ts:88</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">putProviderByTypeAndId</span><a id="__typeputproviderbytypeandid" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeputproviderbytypeandid-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">putProviderByTypeAndId</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeputproviderbytypeandid-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update or create admin federation provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider type</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">providerData</span>: <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a></span><div class="tsd-comment tsd-typography"><p>social identity provider data</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves a social admin federation object</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-2" class="tsd-anchor"></a>Deprecated<a href="#deprecated-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>since v2.0.0 use <a href="Reference.AdminFederation.html#__typeupdateadminfederationprovider" class="tsd-kind-method">updateAdminFederationProvider</a> instead</p>
<pre><code class="javascript"><span class="hl-7">updateAdminFederationProvider</span><span class="hl-0">(</span><span class="hl-3">providerType</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">providerId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">, </span><span class="hl-3">providerData</span><span class="hl-0">: </span><span class="hl-3">SocialIdpSkeleton</span><span class="hl-0">): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">SocialIdpSkeleton</span><span class="hl-0">></span>
</code><button type="button">Copy</button></pre>
</div></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L134">ops/cloud/AdminFederationOps.ts:134</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readAdminFederationProvider</span><a id="__typereadadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typereadadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typereadadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read admin federation provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider id/name</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves a social admin federation object</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L31">ops/cloud/AdminFederationOps.ts:31</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">readAdminFederationProviders</span><a id="__typereadadminfederationproviders" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typereadadminfederationproviders-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">readAdminFederationProviders</span><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typereadadminfederationproviders-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Read all admin federation providers</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an object containing an array of admin federation providers</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/cloud/AdminFederationOps.ts#L25">ops/cloud/AdminFederationOps.ts:25</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">updateAdminFederationProvider</span><a id="__typeupdateadminfederationprovider" class="tsd-anchor"></a><span class="tsd-signature-symbol">:</span>function</h5><ul class="tsd-signatures"><li class=""><div class="tsd-signature tsd-anchor-link"><a id="__typeupdateadminfederationprovider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">updateAdminFederationProvider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">providerType</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.SocialIdpSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">SocialIdpSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeupdateadminfederationprovider-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></div><div class="tsd-description"><div class="tsd-comment tsd-typography"><p>Update or create admin federation provider</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">providerType</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>social identity provider type</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">providerI