-
Notifications
You must be signed in to change notification settings - Fork 25
/
MicrosoftIdentityWebApiAuthenticationBuilderExtensions.xml
172 lines (172 loc) · 16.8 KB
/
MicrosoftIdentityWebApiAuthenticationBuilderExtensions.xml
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
<Type Name="MicrosoftIdentityWebApiAuthenticationBuilderExtensions" FullName="Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions">
<TypeSignature Language="C#" Value="public static class MicrosoftIdentityWebApiAuthenticationBuilderExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit MicrosoftIdentityWebApiAuthenticationBuilderExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module MicrosoftIdentityWebApiAuthenticationBuilderExtensions" />
<TypeSignature Language="F#" Value="type MicrosoftIdentityWebApiAuthenticationBuilderExtensions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.11.0.0</AssemblyVersion>
<AssemblyVersion>2.11.1.0</AssemblyVersion>
<AssemblyVersion>2.12.4.0</AssemblyVersion>
<AssemblyVersion>2.13.0.0</AssemblyVersion>
<AssemblyVersion>2.13.1.0</AssemblyVersion>
<AssemblyVersion>2.13.2.0</AssemblyVersion>
<AssemblyVersion>2.13.3.0</AssemblyVersion>
<AssemblyVersion>2.13.4.0</AssemblyVersion>
<AssemblyVersion>2.14.0.0</AssemblyVersion>
<AssemblyVersion>2.15.1.0</AssemblyVersion>
<AssemblyVersion>2.15.2.0</AssemblyVersion>
<AssemblyVersion>2.15.3.0</AssemblyVersion>
<AssemblyVersion>2.15.5.0</AssemblyVersion>
<AssemblyVersion>2.16.0.0</AssemblyVersion>
<AssemblyVersion>2.16.1.0</AssemblyVersion>
<AssemblyVersion>2.17.0.0</AssemblyVersion>
<AssemblyVersion>2.17.1.0</AssemblyVersion>
<AssemblyVersion>2.17.2.0</AssemblyVersion>
<AssemblyVersion>2.17.3.0</AssemblyVersion>
<AssemblyVersion>2.17.4.0</AssemblyVersion>
<AssemblyVersion>2.17.5.0</AssemblyVersion>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
<AssemblyVersion>2.18.2.0</AssemblyVersion>
<AssemblyVersion>2.19.0.0</AssemblyVersion>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extensions for <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder" /> for startup initialization of web APIs.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="AddMicrosoftIdentityWebApi">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration AddMicrosoftIdentityWebApi (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, Microsoft.Extensions.Configuration.IConfigurationSection configurationSection, string jwtBearerScheme = "Bearer", bool subscribeToJwtBearerMiddlewareDiagnosticsEvents = false);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration AddMicrosoftIdentityWebApi(class Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, class Microsoft.Extensions.Configuration.IConfigurationSection configurationSection, string jwtBearerScheme, bool subscribeToJwtBearerMiddlewareDiagnosticsEvents) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,Microsoft.Extensions.Configuration.IConfigurationSection,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddMicrosoftIdentityWebApi (builder As AuthenticationBuilder, configurationSection As IConfigurationSection, Optional jwtBearerScheme As String = "Bearer", Optional subscribeToJwtBearerMiddlewareDiagnosticsEvents As Boolean = false) As MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration" />
<MemberSignature Language="F#" Value="static member AddMicrosoftIdentityWebApi : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * Microsoft.Extensions.Configuration.IConfigurationSection * string * bool -> Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration" Usage="Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi (builder, configurationSection, jwtBearerScheme, subscribeToJwtBearerMiddlewareDiagnosticsEvents)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(IConfiguration, Object).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Extensions.Configuration.ConfigurationBinder.Bind(IConfiguration, Object).")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.AspNetCore.Authentication.AuthenticationBuilder" RefType="this" />
<Parameter Name="configurationSection" Type="Microsoft.Extensions.Configuration.IConfigurationSection" />
<Parameter Name="jwtBearerScheme" Type="System.String" />
<Parameter Name="subscribeToJwtBearerMiddlewareDiagnosticsEvents" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder" /> to which to add this configuration.</param>
<param name="configurationSection">The configuration second from which to fill-in the options.</param>
<param name="jwtBearerScheme">The JWT bearer scheme name to be used. By default it uses "Bearer".</param>
<param name="subscribeToJwtBearerMiddlewareDiagnosticsEvents">
Set to true if you want to debug, or just understand the JWT bearer events.
</param>
<summary>
Protects the web API with Microsoft identity platform (formerly Azure AD v2.0).
This method expects the configuration file will have a section, named "AzureAd" as default, with the necessary settings to initialize authentication options.
</summary>
<returns>The authentication builder to chain.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddMicrosoftIdentityWebApi">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration AddMicrosoftIdentityWebApi (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, Microsoft.Extensions.Configuration.IConfiguration configuration, string configSectionName = "AzureAd", string jwtBearerScheme = "Bearer", bool subscribeToJwtBearerMiddlewareDiagnosticsEvents = false);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration AddMicrosoftIdentityWebApi(class Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, class Microsoft.Extensions.Configuration.IConfiguration configuration, string configSectionName, string jwtBearerScheme, bool subscribeToJwtBearerMiddlewareDiagnosticsEvents) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,Microsoft.Extensions.Configuration.IConfiguration,System.String,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddMicrosoftIdentityWebApi (builder As AuthenticationBuilder, configuration As IConfiguration, Optional configSectionName As String = "AzureAd", Optional jwtBearerScheme As String = "Bearer", Optional subscribeToJwtBearerMiddlewareDiagnosticsEvents As Boolean = false) As MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration" />
<MemberSignature Language="F#" Value="static member AddMicrosoftIdentityWebApi : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * Microsoft.Extensions.Configuration.IConfiguration * string * string * bool -> Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration" Usage="Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi (builder, configuration, configSectionName, jwtBearerScheme, subscribeToJwtBearerMiddlewareDiagnosticsEvents)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthneticationBuilderExtensions.AddMicrosoftIdentityWebApi(AuthenticationBuilder, IConfigurationSection, string, bool).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthneticationBuilderExtensions.AddMicrosoftIdentityWebApi(AuthenticationBuilder, IConfigurationSection, string, bool).")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderWithConfiguration</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.AspNetCore.Authentication.AuthenticationBuilder" RefType="this" />
<Parameter Name="configuration" Type="Microsoft.Extensions.Configuration.IConfiguration" />
<Parameter Name="configSectionName" Type="System.String" />
<Parameter Name="jwtBearerScheme" Type="System.String" />
<Parameter Name="subscribeToJwtBearerMiddlewareDiagnosticsEvents" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder" /> to which to add this configuration.</param>
<param name="configuration">The configuration instance.</param>
<param name="configSectionName">The configuration section with the necessary settings to initialize authentication options.</param>
<param name="jwtBearerScheme">The JWT bearer scheme name to be used. By default it uses "Bearer".</param>
<param name="subscribeToJwtBearerMiddlewareDiagnosticsEvents">
Set to true if you want to debug, or just understand the JWT bearer events.
</param>
<summary>
Protects the web API with Microsoft identity platform (formerly Azure AD v2.0).
This method expects the configuration file will have a section, named "AzureAd" as default, with the necessary settings to initialize authentication options.
</summary>
<returns>The authentication builder to chain.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AddMicrosoftIdentityWebApi">
<MemberSignature Language="C#" Value="public static Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder AddMicrosoftIdentityWebApi (this Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, Action<Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions> configureJwtBearerOptions, Action<Microsoft.Identity.Web.MicrosoftIdentityOptions> configureMicrosoftIdentityOptions, string jwtBearerScheme = "Bearer", bool subscribeToJwtBearerMiddlewareDiagnosticsEvents = false);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder AddMicrosoftIdentityWebApi(class Microsoft.AspNetCore.Authentication.AuthenticationBuilder builder, class System.Action`1<class Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions> configureJwtBearerOptions, class System.Action`1<class Microsoft.Identity.Web.MicrosoftIdentityOptions> configureMicrosoftIdentityOptions, string jwtBearerScheme, bool subscribeToJwtBearerMiddlewareDiagnosticsEvents) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi(Microsoft.AspNetCore.Authentication.AuthenticationBuilder,System.Action{Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions},System.Action{Microsoft.Identity.Web.MicrosoftIdentityOptions},System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function AddMicrosoftIdentityWebApi (builder As AuthenticationBuilder, configureJwtBearerOptions As Action(Of JwtBearerOptions), configureMicrosoftIdentityOptions As Action(Of MicrosoftIdentityOptions), Optional jwtBearerScheme As String = "Bearer", Optional subscribeToJwtBearerMiddlewareDiagnosticsEvents As Boolean = false) As MicrosoftIdentityWebApiAuthenticationBuilder" />
<MemberSignature Language="F#" Value="static member AddMicrosoftIdentityWebApi : Microsoft.AspNetCore.Authentication.AuthenticationBuilder * Action<Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions> * Action<Microsoft.Identity.Web.MicrosoftIdentityOptions> * string * bool -> Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder" Usage="Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilderExtensions.AddMicrosoftIdentityWebApi (builder, configureJwtBearerOptions, configureMicrosoftIdentityOptions, jwtBearerScheme, subscribeToJwtBearerMiddlewareDiagnosticsEvents)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.19.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder.MicrosoftIdentityWebApiAuthenticationBuilder(IServiceCollection, String, Action<JwtBearerOptions>, Action<MicrosoftIdentityOptions>, IConfigurationSection).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder.MicrosoftIdentityWebApiAuthenticationBuilder(IServiceCollection, String, Action<JwtBearerOptions>, Action<MicrosoftIdentityOptions>, IConfigurationSection).")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Web.MicrosoftIdentityWebApiAuthenticationBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="builder" Type="Microsoft.AspNetCore.Authentication.AuthenticationBuilder" RefType="this" />
<Parameter Name="configureJwtBearerOptions" Type="System.Action<Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions>" />
<Parameter Name="configureMicrosoftIdentityOptions" Type="System.Action<Microsoft.Identity.Web.MicrosoftIdentityOptions>" />
<Parameter Name="jwtBearerScheme" Type="System.String" />
<Parameter Name="subscribeToJwtBearerMiddlewareDiagnosticsEvents" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="builder">The <see cref="T:Microsoft.AspNetCore.Authentication.AuthenticationBuilder" /> to which to add this configuration.</param>
<param name="configureJwtBearerOptions">The action to configure <see cref="T:Microsoft.AspNetCore.Authentication.JwtBearer.JwtBearerOptions" />.</param>
<param name="configureMicrosoftIdentityOptions">The action to configure the <see cref="T:Microsoft.Identity.Web.MicrosoftIdentityOptions" />.</param>
<param name="jwtBearerScheme">The JWT bearer scheme name to be used. By default it uses "Bearer".</param>
<param name="subscribeToJwtBearerMiddlewareDiagnosticsEvents">
Set to true if you want to debug, or just understand the JWT bearer events.</param>
<summary>
Protects the web API with Microsoft identity platform (formerly Azure AD v2.0).
</summary>
<returns>The authentication builder to chain.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>