@archon-inc/sdk
Version:
Integrate easily to our government platform using this SDK. More info on https://archon.inc/sdk
9 lines (8 loc) • 9.42 kB
HTML
<html class="default" lang="en" data-base=".."><head><meta charset="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>determineAccess | @archon-inc/sdk</title><meta name="description" content="Documentation for @archon-inc/sdk"/><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></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"><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"></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">@archon-inc/sdk</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="../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">@archon-inc/sdk</a></li><li><a href="../modules/policy.html">policy</a></li><li><a href="policy.determineAccess.html">determineAccess</a></li></ul><h1>Function determineAccess</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="determineaccess" class="tsd-anchor"></a><span class="tsd-kind-call-signature">determineAccess</span><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">session</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.SessionId.html" class="tsd-signature-type tsd-kind-type-alias">SessionId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.Session.html" class="tsd-signature-type tsd-kind-interface">Session</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">resource</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ArchonResourceId.html" class="tsd-signature-type tsd-kind-type-alias">ArchonResourceId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.Resource.html" class="tsd-signature-type tsd-kind-interface">Resource</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">intent</span><span class="tsd-signature-symbol">:</span> <a href="../types/types.ResourceIntentName.html" class="tsd-signature-type tsd-kind-type-alias">ResourceIntentName</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.ResourceIntent.html" class="tsd-signature-type tsd-kind-interface">ResourceIntent</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/types.AccessDetermination.html" class="tsd-signature-type tsd-kind-interface">AccessDetermination</a><span class="tsd-signature-symbol">></span><a href="#determineaccess" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Given a user session and a resource, determine if the user has access to the resource with the given intent.
This function contacts the Archon policy service to determine access. To edit policies or add new ones,
log into the dashboard and initiate a change.</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">session</span>: <a href="../types/types.SessionId.html" class="tsd-signature-type tsd-kind-type-alias">SessionId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.Session.html" class="tsd-signature-type tsd-kind-interface">Session</a></span><div class="tsd-comment tsd-typography"><p>The session of the user attempting to access the resource.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">resource</span>: <a href="../types/types.ArchonResourceId.html" class="tsd-signature-type tsd-kind-type-alias">ArchonResourceId</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.Resource.html" class="tsd-signature-type tsd-kind-interface">Resource</a></span><div class="tsd-comment tsd-typography"><p>The resource being accessed, identified by its ARID.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">intent</span>: <a href="../types/types.ResourceIntentName.html" class="tsd-signature-type tsd-kind-type-alias">ResourceIntentName</a> <span class="tsd-signature-symbol">|</span> <a href="../interfaces/types.ResourceIntent.html" class="tsd-signature-type tsd-kind-interface">ResourceIntent</a></span><div class="tsd-comment tsd-typography"><p>The intent with which the user is attempting to access the resource.</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/types.AccessDetermination.html" class="tsd-signature-type tsd-kind-interface">AccessDetermination</a><span class="tsd-signature-symbol">></span></h4><p>Whether the user has access to the resource with the given intent.</p>
<div class="tsd-comment tsd-typography"></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/Archon-Technologies/archon-sdk/blob/4c6b0ca403a0b09bc4b38b0a91ee1d8b336c9889/src/policy/determineAccess.ts#L14">policy/determineAccess.ts:14</a></li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><div class="tsd-navigation settings"><details class="tsd-accordion"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="../assets/icons.svg#icon-chevronDown"></use></svg>Settings</h3></summary><div class="tsd-accordion-details"><div class="tsd-filter-visibility"><span class="settings-label">Member Visibility</span><ul id="tsd-filter-options"><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-protected" name="protected"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Protected</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-inherited" name="inherited" checked/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>Inherited</span></label></li><li class="tsd-filter-item"><label class="tsd-filter-input"><input type="checkbox" id="tsd-filter-external" name="external"/><svg width="32" height="32" viewBox="0 0 32 32" aria-hidden="true"><rect class="tsd-checkbox-background" width="30" height="30" x="1" y="1" rx="6" fill="none"></rect><path class="tsd-checkbox-checkmark" d="M8.35422 16.8214L13.2143 21.75L24.6458 10.25" stroke="none" stroke-width="3.5" stroke-linejoin="round" fill="none"></path></svg><span>External</span></label></li></ul></div><div class="tsd-theme-toggle"><label class="settings-label" for="tsd-theme">Theme</label><select id="tsd-theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></div></div></details></div></div><div class="site-menu"><nav class="tsd-navigation"><a href="../modules.html">@archon-inc/sdk</a><ul class="tsd-small-nested-navigation" id="tsd-nav-container"><li>Loading...</li></ul></nav></div></div></div><footer><p class="tsd-generator">Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></footer><div class="overlay"></div></body></html>