-
Notifications
You must be signed in to change notification settings - Fork 112
/
OAuthOptions.xml
266 lines (266 loc) · 16.3 KB
/
OAuthOptions.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
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
265
266
<Type Name="OAuthOptions" FullName="Microsoft.AspNetCore.Builder.OAuthOptions">
<TypeSignature Language="C++ CLI" Value="public ref class OAuthOptions : Microsoft::AspNetCore::Builder::RemoteAuthenticationOptions" />
<TypeSignature Language="C#" Value="public class OAuthOptions : Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit OAuthOptions extends Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions" />
<TypeSignature Language="DocId" Value="T:Microsoft.AspNetCore.Builder.OAuthOptions" />
<TypeSignature Language="VB.NET" Value="Public Class OAuthOptions
Inherits RemoteAuthenticationOptions" />
<TypeSignature Language="F#" Value="type OAuthOptions = class
 inherit RemoteAuthenticationOptions" />
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.AspNetCore.Builder.RemoteAuthenticationOptions</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Configuration options for <see cref="T:Microsoft.AspNetCore.Authentication.OAuth.OAuthMiddleware`1" />.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C++ CLI" Value="public:
 OAuthOptions();" />
<MemberSignature Language="C#" Value="public OAuthOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.AspNetCore.Builder.OAuthOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuthorizationEndpoint">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ AuthorizationEndpoint { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string AuthorizationEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string AuthorizationEndpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.AuthorizationEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property AuthorizationEndpoint As String" />
<MemberSignature Language="F#" Value="member this.AuthorizationEndpoint : string with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.AuthorizationEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the URI where the client will be redirected to authenticate.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientId">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ClientId { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string ClientId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientId" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.ClientId" />
<MemberSignature Language="VB.NET" Value="Public Property ClientId As String" />
<MemberSignature Language="F#" Value="member this.ClientId : string with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.ClientId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the provider-assigned client id.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ClientSecret">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ ClientSecret { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string ClientSecret { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientSecret" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.ClientSecret" />
<MemberSignature Language="VB.NET" Value="Public Property ClientSecret As String" />
<MemberSignature Language="F#" Value="member this.ClientSecret : string with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.ClientSecret" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the provider-assigned client secret.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Events">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Authentication::OAuth::IOAuthEvents ^ Events { Microsoft::AspNetCore::Authentication::OAuth::IOAuthEvents ^ get(); void set(Microsoft::AspNetCore::Authentication::OAuth::IOAuthEvents ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents Events { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents Events" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.Events" />
<MemberSignature Language="VB.NET" Value="Public Property Events As IOAuthEvents" />
<MemberSignature Language="F#" Value="member this.Events : Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.Events" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the <see cref="T:Microsoft.AspNetCore.Authentication.OAuth.IOAuthEvents" /> used to handle authentication events.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Scope">
<MemberSignature Language="C++ CLI" Value="public:
 property System::Collections::Generic::ICollection<System::String ^> ^ Scope { System::Collections::Generic::ICollection<System::String ^> ^ get(); };" />
<MemberSignature Language="C#" Value="public System.Collections.Generic.ICollection<string> Scope { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.ICollection`1<string> Scope" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.Scope" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Scope As ICollection(Of String)" />
<MemberSignature Language="F#" Value="member this.Scope : System.Collections.Generic.ICollection<string>" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.Scope" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Collections.Generic.ICollection<System.String></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the list of permissions to request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="StateDataFormat">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Authentication::ISecureDataFormat<Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^> ^ StateDataFormat { Microsoft::AspNetCore::Authentication::ISecureDataFormat<Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^> ^ get(); void set(Microsoft::AspNetCore::Authentication::ISecureDataFormat<Microsoft::AspNetCore::Http::Authentication::AuthenticationProperties ^> ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Authentication.ISecureDataFormat<Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties> StateDataFormat { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Authentication.ISecureDataFormat`1<class Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties> StateDataFormat" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.StateDataFormat" />
<MemberSignature Language="VB.NET" Value="Public Property StateDataFormat As ISecureDataFormat(Of AuthenticationProperties)" />
<MemberSignature Language="F#" Value="member this.StateDataFormat : Microsoft.AspNetCore.Authentication.ISecureDataFormat<Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties> with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.StateDataFormat" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Authentication.ISecureDataFormat<Microsoft.AspNetCore.Http.Authentication.AuthenticationProperties></ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the type used to secure data handled by the middleware.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SystemClock">
<MemberSignature Language="C++ CLI" Value="public:
 property Microsoft::AspNetCore::Authentication::ISystemClock ^ SystemClock { Microsoft::AspNetCore::Authentication::ISystemClock ^ get(); void set(Microsoft::AspNetCore::Authentication::ISystemClock ^ value); };" />
<MemberSignature Language="C#" Value="public Microsoft.AspNetCore.Authentication.ISystemClock SystemClock { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.AspNetCore.Authentication.ISystemClock SystemClock" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.SystemClock" />
<MemberSignature Language="VB.NET" Value="Public Property SystemClock As ISystemClock" />
<MemberSignature Language="F#" Value="member this.SystemClock : Microsoft.AspNetCore.Authentication.ISystemClock with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.SystemClock" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute FrameworkAlternate="aspnetcore-1.0">
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.AspNetCore.Authentication.ISystemClock</ReturnType>
</ReturnValue>
<Docs>
<summary>
For testing purposes only.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="TokenEndpoint">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ TokenEndpoint { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string TokenEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TokenEndpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.TokenEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property TokenEndpoint As String" />
<MemberSignature Language="F#" Value="member this.TokenEndpoint : string with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.TokenEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the URI the middleware will access to exchange the OAuth token.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserInformationEndpoint">
<MemberSignature Language="C++ CLI" Value="public:
 property System::String ^ UserInformationEndpoint { System::String ^ get(); void set(System::String ^ value); };" />
<MemberSignature Language="C#" Value="public string UserInformationEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string UserInformationEndpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.AspNetCore.Builder.OAuthOptions.UserInformationEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property UserInformationEndpoint As String" />
<MemberSignature Language="F#" Value="member this.UserInformationEndpoint : string with get, set" Usage="Microsoft.AspNetCore.Builder.OAuthOptions.UserInformationEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.AspNetCore.Authentication.OAuth</AssemblyName>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyVersion>1.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets or sets the URI the middleware will access to obtain the user information.
This value is not used in the default implementation, it is for use in custom implementations of
IOAuthAuthenticationEvents.Authenticated or OAuthAuthenticationHandler.CreateTicketAsync.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>