-
Notifications
You must be signed in to change notification settings - Fork 32
/
AuthorizationHeaderProviderOptions.xml
316 lines (316 loc) · 17.9 KB
/
AuthorizationHeaderProviderOptions.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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
<Type Name="AuthorizationHeaderProviderOptions" FullName="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions">
<TypeSignature Language="C#" Value="public class AuthorizationHeaderProviderOptions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AuthorizationHeaderProviderOptions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" />
<TypeSignature Language="VB.NET" Value="Public Class AuthorizationHeaderProviderOptions" />
<TypeSignature Language="F#" Value="type AuthorizationHeaderProviderOptions = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>2.1.0.0</AssemblyVersion>
<AssemblyVersion>3.1.0.0</AssemblyVersion>
<AssemblyVersion>3.2.0.0</AssemblyVersion>
<AssemblyVersion>3.2.1.0</AssemblyVersion>
<AssemblyVersion>4.0.0.0</AssemblyVersion>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
<AssemblyVersion>5.0.0.0</AssemblyVersion>
<AssemblyVersion>5.1.0.0</AssemblyVersion>
<AssemblyVersion>5.3.0.0</AssemblyVersion>
<AssemblyVersion>6.0.0.0</AssemblyVersion>
<AssemblyVersion>7.0.0.0</AssemblyVersion>
<AssemblyVersion>7.1.0.0</AssemblyVersion>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Options passed-in to call downstream web APIs. To call Microsoft Graph, see rather
<c>MicrosoftGraphOptions</c> in the <c>Microsoft.Identity.Web.MicrosoftGraph</c> assembly.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthorizationHeaderProviderOptions ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>
Default constructor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthorizationHeaderProviderOptions (Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.#ctor(Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (other As AuthorizationHeaderProviderOptions)" />
<MemberSignature Language="F#" Value="new Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions : Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions -> Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="new Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions other" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="other" Type="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" />
</Parameters>
<Docs>
<param name="other">Options to copy from.</param>
<summary>
Copy constructor for <see cref="T:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" /></summary>
<remarks>To be added.</remarks>
<exception cref="T:System.ArgumentNullException">Thrown if <paramref name="other" /> is <c>null</c>.</exception>
</Docs>
</Member>
<Member MemberName="AcquireTokenOptions">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Abstractions.AcquireTokenOptions AcquireTokenOptions { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Abstractions.AcquireTokenOptions AcquireTokenOptions" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.AcquireTokenOptions" />
<MemberSignature Language="VB.NET" Value="Public Property AcquireTokenOptions As AcquireTokenOptions" />
<MemberSignature Language="F#" Value="member this.AcquireTokenOptions : Microsoft.Identity.Abstractions.AcquireTokenOptions with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.AcquireTokenOptions" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Abstractions.AcquireTokenOptions</ReturnType>
</ReturnValue>
<Docs>
<summary>
Options related to token acquisition.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BaseUrl">
<MemberSignature Language="C#" Value="public string? BaseUrl { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string BaseUrl" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" />
<MemberSignature Language="VB.NET" Value="Public Property BaseUrl As String" />
<MemberSignature Language="F#" Value="member this.BaseUrl : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Base URL for the called downstream web API. For instance <c>"https://graph.microsoft.com/beta/"</c>.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Clone">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions Clone ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions Clone() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.Clone" />
<MemberSignature Language="VB.NET" Value="Public Function Clone () As AuthorizationHeaderProviderOptions" />
<MemberSignature Language="F#" Value="member this.Clone : unit -> Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="authorizationHeaderProviderOptions.Clone " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CloneInternal">
<MemberSignature Language="C#" Value="protected virtual Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions CloneInternal ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance class Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions CloneInternal() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CloneInternal" />
<MemberSignature Language="VB.NET" Value="Protected Overridable Function CloneInternal () As AuthorizationHeaderProviderOptions" />
<MemberSignature Language="F#" Value="abstract member CloneInternal : unit -> Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions
override this.CloneInternal : unit -> Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions" Usage="authorizationHeaderProviderOptions.CloneInternal " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Clone the options (to be able to override them).
</summary>
<returns>A clone of the options.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CustomizeHttpRequestMessage">
<MemberSignature Language="C#" Value="public Action<System.Net.Http.HttpRequestMessage>? CustomizeHttpRequestMessage { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Action`1<class System.Net.Http.HttpRequestMessage> CustomizeHttpRequestMessage" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CustomizeHttpRequestMessage" />
<MemberSignature Language="VB.NET" Value="Public Property CustomizeHttpRequestMessage As Action(Of HttpRequestMessage)" />
<MemberSignature Language="F#" Value="member this.CustomizeHttpRequestMessage : Action<System.Net.Http.HttpRequestMessage> with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.CustomizeHttpRequestMessage" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Action<System.Net.Http.HttpRequestMessage></ReturnType>
</ReturnValue>
<Docs>
<summary>
Provides an opportunity for the caller app to customize the HttpRequestMessage. For example,
to customize the headers. This is called after the message was formed, including
the Authorization header, and just before the message is sent.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetApiUrl">
<MemberSignature Language="C#" Value="public string GetApiUrl ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance string GetApiUrl() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.GetApiUrl" />
<MemberSignature Language="VB.NET" Value="Public Function GetApiUrl () As String" />
<MemberSignature Language="F#" Value="member this.GetApiUrl : unit -> string" Usage="authorizationHeaderProviderOptions.GetApiUrl " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Return the downstream web API URL.
</summary>
<returns>URL of the downstream web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HttpMethod">
<MemberSignature Language="C#" Value="public string HttpMethod { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string HttpMethod" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.HttpMethod" />
<MemberSignature Language="VB.NET" Value="Public Property HttpMethod As String" />
<MemberSignature Language="F#" Value="member this.HttpMethod : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.HttpMethod" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("Get")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("Get")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
HTTP method used to call this downstream web API (by default Get).
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ProtocolScheme">
<MemberSignature Language="C#" Value="public string ProtocolScheme { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ProtocolScheme" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.ProtocolScheme" />
<MemberSignature Language="VB.NET" Value="Public Property ProtocolScheme As String" />
<MemberSignature Language="F#" Value="member this.ProtocolScheme : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.ProtocolScheme" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.DefaultValue("Bearer")]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.DefaultValue("Bearer")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Name of the protocol scheme used to create the authorization header. By default: "Bearer".
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RelativePath">
<MemberSignature Language="C#" Value="public string RelativePath { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RelativePath" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RelativePath" />
<MemberSignature Language="VB.NET" Value="Public Property RelativePath As String" />
<MemberSignature Language="F#" Value="member this.RelativePath : string with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RelativePath" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Path relative to the <see cref="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.BaseUrl" /> (for instance "me").
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RequestAppToken">
<MemberSignature Language="C#" Value="public bool RequestAppToken { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequestAppToken" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RequestAppToken" />
<MemberSignature Language="VB.NET" Value="Public Property RequestAppToken As Boolean" />
<MemberSignature Language="F#" Value="member this.RequestAppToken : bool with get, set" Usage="Microsoft.Identity.Abstractions.AuthorizationHeaderProviderOptions.RequestAppToken" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Abstractions</AssemblyName>
<AssemblyVersion>7.2.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Describes if the downstream API is called on behalf of the calling service itself
(App token) or on behalf of a user processed by the service (user token).
If <c>true</c>, the token is requested on behalf of the app. Otherwise, it on-behalf of the user.
</summary>
<value>To be added.</value>
<remarks>This is especially usefull when the call to the downstream API is described
by configuration.</remarks>
</Docs>
</Member>
</Members>
</Type>