Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity
CommunitySolidServer/docs/interfaces/IdentityProviderHttpHandlerArgs.html
RubenVerborgh 561f4663e3 deploy: 216788e225960bf42a74d22ba237a70deb09f77c
2021-10-15 09:28:28 +00:00

15 lines
12 KiB
HTML
Raw Blame History

<!DOCTYPE html><html class="default no-js"><head><meta charSet="utf-8"/><meta http-equiv="X-UA-Compatible" content="IE=edge"/><title>IdentityProviderHttpHandlerArgs | Community Solid Server - v2.0.0</title><meta name="description" content="Documentation for Community Solid Server - v2.0.0"/><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 async src="../assets/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-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></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">Community Solid Server - v2.0.0</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">Community Solid Server - v2.0.0</a></li><li><a href="IdentityProviderHttpHandlerArgs.html">IdentityProviderHttpHandlerArgs</a></li></ul><h1>Interface IdentityProviderHttpHandlerArgs</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">IdentityProviderHttpHandlerArgs</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="IdentityProviderHttpHandlerArgs.html#baseUrl" class="tsd-kind-icon">base<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#idpPath" class="tsd-kind-icon">idp<wbr/>Path</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#interactionCompleter" class="tsd-kind-icon">interaction<wbr/>Completer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#interactionRoutes" class="tsd-kind-icon">interaction<wbr/>Routes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#providerFactory" class="tsd-kind-icon">provider<wbr/>Factory</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="baseUrl" class="tsd-anchor"></a><h3>base<wbr/>Url</h3><div class="tsd-signature tsd-kind-icon">base<wbr/>Url<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/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L28">src/identity/IdentityProviderHttpHandler.ts:28</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Base URL of the server.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="converter" class="tsd-anchor"></a><h3>converter</h3><div class="tsd-signature tsd-kind-icon">converter<span class="tsd-signature-symbol">:</span> <a href="../classes/RepresentationConverter.html" class="tsd-signature-type" data-tsd-kind="Class">RepresentationConverter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L44">src/identity/IdentityProviderHttpHandler.ts:44</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Used for content negotiation.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="errorHandler" class="tsd-anchor"></a><h3>error<wbr/>Handler</h3><div class="tsd-signature tsd-kind-icon">error<wbr/>Handler<span class="tsd-signature-symbol">:</span> <a href="../classes/ErrorHandler.html" class="tsd-signature-type" data-tsd-kind="Class">ErrorHandler</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L52">src/identity/IdentityProviderHttpHandler.ts:52</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Used for converting output errors.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="idpPath" class="tsd-anchor"></a><h3>idp<wbr/>Path</h3><div class="tsd-signature tsd-kind-icon">idp<wbr/>Path<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/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L32">src/identity/IdentityProviderHttpHandler.ts:32</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Relative path of the IDP entry point.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="interactionCompleter" class="tsd-anchor"></a><h3>interaction<wbr/>Completer</h3><div class="tsd-signature tsd-kind-icon">interaction<wbr/>Completer<span class="tsd-signature-symbol">:</span> <a href="../classes/InteractionCompleter.html" class="tsd-signature-type" data-tsd-kind="Class">InteractionCompleter</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L48">src/identity/IdentityProviderHttpHandler.ts:48</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Used for POST requests that need to be handled by the OIDC library.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="interactionRoutes" class="tsd-anchor"></a><h3>interaction<wbr/>Routes</h3><div class="tsd-signature tsd-kind-icon">interaction<wbr/>Routes<span class="tsd-signature-symbol">:</span> <a href="InteractionRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">InteractionRoute</a><span class="tsd-signature-symbol">[]</span></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L40">src/identity/IdentityProviderHttpHandler.ts:40</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>All routes handling the custom IDP behaviour.</p>
</div></div></section><section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface"><a name="providerFactory" class="tsd-anchor"></a><h3>provider<wbr/>Factory</h3><div class="tsd-signature tsd-kind-icon">provider<wbr/>Factory<span class="tsd-signature-symbol">:</span> <a href="ProviderFactory.html" class="tsd-signature-type" data-tsd-kind="Interface">ProviderFactory</a></div><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/solid/community-server/blob/216788e/src/identity/IdentityProviderHttpHandler.ts#L36">src/identity/IdentityProviderHttpHandler.ts:36</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
<p>Used to generate the OIDC 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">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html" class="tsd-kind-icon">Identity<wbr/>Provider<wbr/>Http<wbr/>Handler<wbr/>Args</a><ul><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#baseUrl" class="tsd-kind-icon">base<wbr/>Url</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#converter" class="tsd-kind-icon">converter</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#errorHandler" class="tsd-kind-icon">error<wbr/>Handler</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#idpPath" class="tsd-kind-icon">idp<wbr/>Path</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#interactionCompleter" class="tsd-kind-icon">interaction<wbr/>Completer</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#interactionRoutes" class="tsd-kind-icon">interaction<wbr/>Routes</a></li><li class="tsd-kind-property tsd-parent-kind-interface"><a href="IdentityProviderHttpHandlerArgs.html#providerFactory" class="tsd-kind-icon">provider<wbr/>Factory</a></li></ul></li></ul></nav></div></div></div><footer class=""><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li><li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="overlay"></div><script src="../assets/main.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink