ngrok/ngrok-api-typescript
1
0
Fork 0
mirror of https://github.com/ngrok/ngrok-api-typescript.git synced 2026-06-16 16:54:32 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
main
ngrok-api-typescript/docs/interfaces/datatypes.EndpointOIDC.html
T

319 lines
14 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>EndpointOIDC | @ngrok/ngrok-api</title>
<meta name="description" content="Documentation for @ngrok/ngrok-api">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</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">@ngrok/ngrok-api</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../modules.html">@ngrok/ngrok-api</a>
</li>
<li>
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li>
<a href="datatypes.EndpointOIDC.html">EndpointOIDC</a>
</li>
</ul>
<h1>Interface EndpointOIDC</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">EndpointOIDC</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#enabled" class="tsd-kind-icon">enabled</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#issuer" class="tsd-kind-icon">issuer</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOIDC.html#scopes" class="tsd-kind-icon">scopes</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="clientId" class="tsd-anchor"></a>
<h3>client<wbr>Id</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L999">datatypes.ts:999</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The OIDC app&#39;s client ID and OIDC audience.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="clientSecret" class="tsd-anchor"></a>
<h3>client<wbr>Secret</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1001">datatypes.ts:1001</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The OIDC app&#39;s client secret.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="cookiePrefix" class="tsd-anchor"></a>
<h3>cookie<wbr>Prefix</h3>
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L991">datatypes.ts:991</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is &#39;ngrok.&#39;</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="enabled" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L987">datatypes.ts:987</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="inactivityTimeout" class="tsd-anchor"></a>
<h3>inactivity<wbr>Timeout</h3>
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L993">datatypes.ts:993</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="issuer" class="tsd-anchor"></a>
<h3>issuer</h3>
<div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L997">datatypes.ts:997</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>URL of the OIDC &quot;OpenID provider&quot;. This is the base URL used for discovery.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="maximumDuration" class="tsd-anchor"></a>
<h3>maximum<wbr>Duration</h3>
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L995">datatypes.ts:995</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="optionsPassthrough" class="tsd-anchor"></a>
<h3>options<wbr>Passthrough</h3>
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L989">datatypes.ts:989</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="scopes" class="tsd-anchor"></a>
<h3>scopes</h3>
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1003">datatypes.ts:1003</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The set of scopes to request from the OIDC identity provider.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Modules</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/client.html">client</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/datatypes.html">datatypes</a>
</li>
<li class=" tsd-kind-module">
<a href="../modules/services.html">services</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="datatypes.EndpointOIDC.html" class="tsd-kind-icon">EndpointOIDC</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#clientId" class="tsd-kind-icon">client<wbr>Id</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#cookiePrefix" class="tsd-kind-icon">cookie<wbr>Prefix</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#enabled" class="tsd-kind-icon">enabled</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#inactivityTimeout" class="tsd-kind-icon">inactivity<wbr>Timeout</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#issuer" class="tsd-kind-icon">issuer</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#maximumDuration" class="tsd-kind-icon">maximum<wbr>Duration</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#optionsPassthrough" class="tsd-kind-icon">options<wbr>Passthrough</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="datatypes.EndpointOIDC.html#scopes" class="tsd-kind-icon">scopes</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink