@rockcarver/frodo-lib
Version:
A library to manage ForgeRock Identity Cloud tenants, ForgeOps deployments, and classic deployments.
60 lines (55 loc) • 66.5 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>Saml2 | 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.Saml2.html">Saml2</a></li></ul><h1>Type Alias Saml2</h1></div><div class="tsd-signature"><span class="tsd-kind-type-alias">Saml2</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-call-signature">createSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProiderLocation.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProiderLocation</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">metaData</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteSaml2Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">deleteSaml2Providers</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</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">exportSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">entityId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">exportSaml2Providers</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getProviderMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getProviderMetadataUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSaml2Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSaml2ProviderMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSaml2ProviderMetadataUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSaml2ProviderStub</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">getSaml2ProviderStubs</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</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">importSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">entityId</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.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesImportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesImportOptions</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">importSaml2Providers</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.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesImportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesImportOptions</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</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">readSaml2Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSaml2ProviderStub</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-call-signature">readSaml2ProviderStubs</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</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">updateSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProiderLocation.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProiderLocation</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</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">createSaml2Provider</span><a id="__typecreatesaml2provider" 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="__typecreatesaml2provider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">createSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">location</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProiderLocation.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProiderLocation</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">providerData</span><span class="tsd-signature-symbol">:</span> <a href="Reference.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">metaData</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typecreatesaml2provider-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 a SAML2 entity 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">location</span>: <a href="Reference.Saml2ProiderLocation.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProiderLocation</a></span><div class="tsd-comment tsd-typography"><p>'hosted' or 'remote'</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">providerData</span>: <a href="Reference.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a></span><div class="tsd-comment tsd-typography"><p>Object representing a SAML entity provider</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">metaData</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Base64-encoded metadata XML. Only required for remote providers</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to a saml2 entity 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/Saml2Ops.ts#L60">ops/Saml2Ops.ts:60</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteSaml2Provider</span><a id="__typedeletesaml2provider" 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="__typedeletesaml2provider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteSaml2Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typedeletesaml2provider-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 an entity provider. The response can be saved to file as is.</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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Provider entity id</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a Saml2ExportInterface 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/Saml2Ops.ts#L82">ops/Saml2Ops.ts:82</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">deleteSaml2Providers</span><a id="__typedeletesaml2providers" 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="__typedeletesaml2providers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">deleteSaml2Providers</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typedeletesaml2providers-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 all entity 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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to an array of Saml2ProviderSkeleton objects.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/rockcarver/frodo-lib/blob/f234c5e154a537fe28d9a8daa262cff1cd1216c9/src/ops/Saml2Ops.ts#L87">ops/Saml2Ops.ts:87</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportSaml2Provider</span><a id="__typeexportsaml2provider" 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="__typeexportsaml2provider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">entityId</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">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportsaml2provider-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 a single entity provider. The response can be saved to file as is.</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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Provider entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a Saml2ExportInterface 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/Saml2Ops.ts#L106">ops/Saml2Ops.ts:106</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">exportSaml2Providers</span><a id="__typeexportsaml2providers" 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="__typeexportsaml2providers-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">exportSaml2Providers</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/Reference.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span><a href="#__typeexportsaml2providers-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 entity providers. The response can be saved to file as is.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../interfaces/Reference.Saml2EntitiesExportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesExportOptions</a></span><div class="tsd-comment tsd-typography"><p>export options</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.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a Saml2ExportInterface 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/Saml2Ops.ts#L115">ops/Saml2Ops.ts:115</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getProviderMetadata</span><a id="__typegetprovidermetadata" 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="__typegetprovidermetadata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getProviderMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#__typegetprovidermetadata-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 a SAML2 entity provider's metadata by entity 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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SAML2 entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an object containing a SAML2 metadata</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.Saml2.html#__typegetsaml2providermetadata" class="tsd-kind-method">getSaml2ProviderMetadata</a> instead</p>
<pre><code class="javascript"><span class="hl-7">getSaml2ProviderMetadata</span><span class="hl-0">(</span><span class="hl-3">entityId</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">any</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/Saml2Ops.ts#L174">ops/Saml2Ops.ts:174</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getProviderMetadataUrl</span><a id="__typegetprovidermetadataurl" 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="__typegetprovidermetadataurl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getProviderMetadataUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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">string</span><a href="#__typegetprovidermetadataurl-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 a SAML2 entity provider's metadata URL by entity 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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SAML2 entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the URL to get the metadata from</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.Saml2.html#__typegetsaml2providermetadataurl" class="tsd-kind-method">getSaml2ProviderMetadataUrl</a> instead</p>
<pre><code class="javascript"><span class="hl-7">getSaml2ProviderMetadataUrl</span><span class="hl-0">(</span><span class="hl-3">entityId</span><span class="hl-0">: </span><span class="hl-3">string</span><span class="hl-0">): </span><span class="hl-3">string</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/Saml2Ops.ts#L163">ops/Saml2Ops.ts:163</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getSaml2Provider</span><a id="__typegetsaml2provider" 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="__typegetsaml2provider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSaml2Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typegetsaml2provider-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 a single entity provider. The response can be saved to file as is.</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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Provider entity id</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a Saml2ExportInterface 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.Saml2.html#__typereadsaml2provider" class="tsd-kind-method">readSaml2Provider</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readSaml2Provider</span><span class="hl-0">(</span><span class="hl-3">entityId</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">Saml2ProviderSkeleton</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/Saml2Ops.ts#L196">ops/Saml2Ops.ts:196</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getSaml2ProviderMetadata</span><a id="__typegetsaml2providermetadata" 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="__typegetsaml2providermetadata-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSaml2ProviderMetadata</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#__typegetsaml2providermetadata-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 a SAML2 entity provider's metadata by entity 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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SAML2 entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an object containing a SAML2 metadata</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/Saml2Ops.ts#L99">ops/Saml2Ops.ts:99</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getSaml2ProviderMetadataUrl</span><a id="__typegetsaml2providermetadataurl" 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="__typegetsaml2providermetadataurl-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSaml2ProviderMetadataUrl</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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">string</span><a href="#__typegetsaml2providermetadataurl-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 a SAML2 entity provider's metadata URL by entity 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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>SAML2 entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4><p>the URL to get the metadata from</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/Saml2Ops.ts#L93">ops/Saml2Ops.ts:93</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getSaml2ProviderStub</span><a id="__typegetsaml2providerstub" 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="__typegetsaml2providerstub-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSaml2ProviderStub</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">entityId</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">></span><a href="#__typegetsaml2providerstub-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-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Provider entity id</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">></span></h4><p>Promise resolving to a Saml2ExportInterface object.</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-3" class="tsd-anchor"></a>Deprecated<a href="#deprecated-3" 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.Saml2.html#__typereadsaml2providerstub" class="tsd-kind-method">readSaml2ProviderStub</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readSaml2ProviderStub</span><span class="hl-0">(</span><span class="hl-3">entityId</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">Saml2ProviderStub</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/Saml2Ops.ts#L185">ops/Saml2Ops.ts:185</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">getSaml2ProviderStubs</span><a id="__typegetsaml2providerstubs" 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="__typegetsaml2providerstubs-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">getSaml2ProviderStubs</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.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span><a href="#__typegetsaml2providerstubs-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 SAML2 entity provider stubs</p>
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="Reference.Saml2ProviderStub.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderStub</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4><p>a promise that resolves to an array of saml2 entity stubs</p>
<div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link"><a id="deprecated-4" class="tsd-anchor"></a>Deprecated<a href="#deprecated-4" 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.Saml2.html#__typereadsaml2providerstubs" class="tsd-kind-method">readSaml2ProviderStubs</a> instead</p>
<pre><code class="javascript"><span class="hl-7">readSaml2ProviderStubs</span><span class="hl-0">(): </span><span class="hl-10">Promise</span><span class="hl-0"><</span><span class="hl-3">Saml2ProviderStub</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/Saml2Ops.ts#L152">ops/Saml2Ops.ts:152</a></li></ul></aside></div></li></ul></li><li class="tsd-parameter"><h5><span class="tsd-kind-method">importSaml2Provider</span><a id="__typeimportsaml2provider" 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="__typeimportsaml2provider-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">importSaml2Provider</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">entityId</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.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../interfaces/Reference.Saml2EntitiesImportOptions.html" class="tsd-signature-type tsd-kind-interface">Saml2EntitiesImportOptions</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.Saml2ProviderSkeleton.html" class="tsd-signature-type tsd-kind-type-alias">Saml2ProviderSkeleton</a><span class="tsd-signature-symbol">></span><a href="#__typeimportsaml2provider-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 a SAML entity 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">entityId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>Provider entity id</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">importData</span>: <a href="../interfaces/Reference.Saml2ExportInterface.html" class="tsd-signature-type tsd-kind-interface">Saml2ExportInterface</a></span><div class="tsd-comment tsd-typography"><p>Import data</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">