-
Notifications
You must be signed in to change notification settings - Fork 36
/
Copy pathAuth0.AspNetCore.Authentication.ServiceCollectionExtensions.html
264 lines (190 loc) · 12.4 KB
/
Auth0.AspNetCore.Authentication.ServiceCollectionExtensions.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<title>Class ServiceCollectionExtensions
</title>
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="title" content="Class ServiceCollectionExtensions
">
<link rel="icon" href="../images/logo.png">
<link rel="stylesheet" href="../public/docfx.min.css">
<link rel="stylesheet" href="../public/main.css">
<meta name="docfx:navrel" content="../toc.html">
<meta name="docfx:tocrel" content="toc.html">
<meta name="docfx:docurl" content="https://github.com/auth0/auth0-aspnetcore-authentication/new/release/1.4.1/apiSpec/new?filename=Auth0_AspNetCore_Authentication_ServiceCollectionExtensions.md&value=---%0Auid%3A%20Auth0.AspNetCore.Authentication.ServiceCollectionExtensions%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">
<meta name="loc:inThisArticle" content="In this article">
<meta name="loc:searchResultsCount" content="{count} results for "{query}"">
<meta name="loc:searchNoResults" content="No results for "{query}"">
<meta name="loc:tocFilter" content="Filter by title">
<meta name="loc:nextArticle" content="Next">
<meta name="loc:prevArticle" content="Previous">
<meta name="loc:themeLight" content="Light">
<meta name="loc:themeDark" content="Dark">
<meta name="loc:themeAuto" content="Auto">
<meta name="loc:changeTheme" content="Change theme">
<meta name="loc:copy" content="Copy">
</head>
<script type="module">
import options from './../public/main.js'
import { init } from './../public/docfx.min.js'
init(options)
</script>
<script>
const theme = localStorage.getItem('theme') || 'auto'
document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme)
</script>
<body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference">
<header class="bg-body border-bottom">
<nav id="autocollapse" class="navbar navbar-expand-md" role="navigation">
<div class="container-xxl flex-nowrap">
<a class="navbar-brand" href="../index.html">
<img id="logo" class="svg" src="../images/logo.png" alt="">
</a>
<button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation">
<i class="bi bi-three-dots"></i>
</button>
<div class="collapse navbar-collapse" id="navpanel">
<div id="navbar">
</div>
</div>
</div>
</nav>
</header>
<main class="container-xxl">
<div class="toc-offcanvas">
<div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel">
<div class="offcanvas-header">
<h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>
<button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button>
</div>
<div class="offcanvas-body">
<nav class="toc" id="toc"></nav>
</div>
</div>
</div>
<div class="content">
<div class="actionbar">
<button class="btn btn-lg border-0 d-md-none" style="margin-top: -.65em; margin-left: -.8em" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents">
<i class="bi bi-list"></i>
</button>
<nav id="breadcrumb"></nav>
</div>
<article data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions">
<h1 id="Auth0_AspNetCore_Authentication_ServiceCollectionExtensions" data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions" class="text-break">
Class ServiceCollectionExtensions
<a class="header-action link-secondary" title="View source" href="https://github.com/auth0/auth0-aspnetcore-authentication/blob/release/1.4.1/src/Auth0.AspNetCore.Authentication/ServiceCollectionExtensions.cs/#L9"><i class="bi bi-code-slash"></i></a>
</h1>
<div class="facts text-secondary">
<dl><dt>Namespace</dt><dd><a class="xref" href="Auth0.html">Auth0</a>.<a class="xref" href="Auth0.AspNetCore.html">AspNetCore</a>.<a class="xref" href="Auth0.AspNetCore.Authentication.html">Authentication</a></dd></dl>
<dl><dt>Assembly</dt><dd>Auth0.AspNetCore.Authentication.dll</dd></dl>
</div>
<div class="markdown summary"><p>Contains <a href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a> extension(s) for registering Auth0.</p>
</div>
<div class="markdown conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static class ServiceCollectionExtensions</code></pre>
</div>
<dl class="typelist inheritance">
<dt>Inheritance</dt>
<dd>
<div><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object">object</a></div>
<div><span class="xref">ServiceCollectionExtensions</span></div>
</dd>
</dl>
<dl class="typelist derived">
<dt>Inherited Members</dt>
<dd>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)">object.Equals(object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)">object.Equals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gethashcode">object.GetHashCode()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.gettype">object.GetType()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone">object.MemberwiseClone()</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.referenceequals">object.ReferenceEquals(object, object)</a>
</div>
<div>
<a class="xref" href="https://learn.microsoft.com/dotnet/api/system.object.tostring">object.ToString()</a>
</div>
</dd></dl>
<h2 class="section" id="methods">Methods
</h2>
<a id="Auth0_AspNetCore_Authentication_ServiceCollectionExtensions_AddAuth0WebAppAuthentication_" data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions.AddAuth0WebAppAuthentication*"></a>
<h3 id="Auth0_AspNetCore_Authentication_ServiceCollectionExtensions_AddAuth0WebAppAuthentication_Microsoft_Extensions_DependencyInjection_IServiceCollection_System_Action_Auth0_AspNetCore_Authentication_Auth0WebAppOptions__" data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions.AddAuth0WebAppAuthentication(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.Action{Auth0.AspNetCore.Authentication.Auth0WebAppOptions})">
AddAuth0WebAppAuthentication(IServiceCollection, Action<Auth0WebAppOptions>)
<a class="header-action link-secondary" title="View source" href="https://github.com/auth0/auth0-aspnetcore-authentication/blob/release/1.4.1/src/Auth0.AspNetCore.Authentication/ServiceCollectionExtensions.cs/#L17"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Add Auth0 configuration using Open ID Connect</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Auth0WebAppAuthenticationBuilder AddAuth0WebAppAuthentication(this IServiceCollection services, Action<Auth0WebAppOptions> configureOptions)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>services</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></dt>
<dd><p>The original <a href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a> instance</p>
</dd>
<dt><code>configureOptions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppOptions.html">Auth0WebAppOptions</a>></dt>
<dd><p>A delegate used to configure the <a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppOptions.html">Auth0WebAppOptions</a></p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppAuthenticationBuilder.html">Auth0WebAppAuthenticationBuilder</a></dt>
<dd><p>The <a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppAuthenticationBuilder.html">Auth0WebAppAuthenticationBuilder</a> instance that has been created.</p>
</dd>
</dl>
<a id="Auth0_AspNetCore_Authentication_ServiceCollectionExtensions_AddAuth0WebAppAuthentication_" data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions.AddAuth0WebAppAuthentication*"></a>
<h3 id="Auth0_AspNetCore_Authentication_ServiceCollectionExtensions_AddAuth0WebAppAuthentication_Microsoft_Extensions_DependencyInjection_IServiceCollection_System_String_System_Action_Auth0_AspNetCore_Authentication_Auth0WebAppOptions__" data-uid="Auth0.AspNetCore.Authentication.ServiceCollectionExtensions.AddAuth0WebAppAuthentication(Microsoft.Extensions.DependencyInjection.IServiceCollection,System.String,System.Action{Auth0.AspNetCore.Authentication.Auth0WebAppOptions})">
AddAuth0WebAppAuthentication(IServiceCollection, string, Action<Auth0WebAppOptions>)
<a class="header-action link-secondary" title="View source" href="https://github.com/auth0/auth0-aspnetcore-authentication/blob/release/1.4.1/src/Auth0.AspNetCore.Authentication/ServiceCollectionExtensions.cs/#L28"><i class="bi bi-code-slash"></i></a>
</h3>
<div class="markdown level1 summary"><p>Add Auth0 configuration using Open ID Connect</p>
</div>
<div class="markdown level1 conceptual"></div>
<div class="codewrapper">
<pre><code class="lang-csharp hljs">public static Auth0WebAppAuthenticationBuilder AddAuth0WebAppAuthentication(this IServiceCollection services, string authenticationScheme, Action<Auth0WebAppOptions> configureOptions)</code></pre>
</div>
<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>services</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a></dt>
<dd><p>The original <a href="https://docs.microsoft.com/en-us/dotnet/api/microsoft.extensions.dependencyinjection.iservicecollection">IServiceCollection</a> instance</p>
</dd>
<dt><code>authenticationScheme</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></dt>
<dd></dd>
<dt><code>configureOptions</code> <a class="xref" href="https://learn.microsoft.com/dotnet/api/system.action-1">Action</a><<a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppOptions.html">Auth0WebAppOptions</a>></dt>
<dd><p>A delegate used to configure the <a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppOptions.html">Auth0WebAppOptions</a></p>
</dd>
</dl>
<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppAuthenticationBuilder.html">Auth0WebAppAuthenticationBuilder</a></dt>
<dd><p>The <a class="xref" href="Auth0.AspNetCore.Authentication.Auth0WebAppAuthenticationBuilder.html">Auth0WebAppAuthenticationBuilder</a> instance that has been created.</p>
</dd>
</dl>
</article>
</div>
<div class="affix">
<nav id="affix"></nav>
</div>
</main>
<footer class="border-top">
<div class="container-xxl">
<div class="flex-fill">
<span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span>
</div>
</div>
</footer>
</body>
</html>