/
DownstreamWebApiGenericExtensions.xml
437 lines (437 loc) · 39.8 KB
/
DownstreamWebApiGenericExtensions.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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
<Type Name="DownstreamWebApiGenericExtensions" FullName="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions">
<TypeSignature Language="C#" Value="public static class DownstreamWebApiGenericExtensions" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract sealed beforefieldinit DownstreamWebApiGenericExtensions extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions" />
<TypeSignature Language="VB.NET" Value="Public Module DownstreamWebApiGenericExtensions" />
<TypeSignature Language="F#" Value="type DownstreamWebApiGenericExtensions = 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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Extensions for the downstream web API.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="CallWebApiForUserAsync<TOutput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<TOutput?> CallWebApiForUserAsync<TOutput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default) where TOutput : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!TOutput> CallWebApiForUserAsync<class TOutput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.CallWebApiForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function CallWebApiForUserAsync(Of TOutput As Class) (downstreamWebApi As IDownstreamWebApi, serviceName As String, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task(Of TOutput)" />
<MemberSignature Language="F#" Value="static member CallWebApiForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.CallWebApiForUserAsync (downstreamWebApi, serviceName, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.CallWebApiForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.CallWebApiForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TOutput></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TOutput">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TOutput">Output type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Call a web API endpoint with an HttpGet,
and return strongly typed data.
</summary>
<returns>The value returned by the downstream web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetForUserAsync<TInput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task GetForUserAsync<TInput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, TInput inputData, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task GetForUserAsync<TInput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, !!TInput inputData, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,``0,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetForUserAsync(Of TInput) (downstreamWebApi As IDownstreamWebApi, serviceName As String, inputData As TInput, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member GetForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * 'Input * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync (downstreamWebApi, serviceName, inputData, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertFromInput<TInput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertFromInput<TInput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.GetForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.GetForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TInput" />
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="inputData" Type="TInput" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="inputData">Input data.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Call a web API with a strongly typed input, with an HttpGet.
</summary>
<returns>The value returned by the downstream web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetForUserAsync<TOutput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<TOutput?> GetForUserAsync<TOutput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default) where TOutput : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!TOutput> GetForUserAsync<class TOutput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function GetForUserAsync(Of TOutput As Class) (downstreamWebApi As IDownstreamWebApi, serviceName As String, relativePath As String, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task(Of TOutput)" />
<MemberSignature Language="F#" Value="static member GetForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.GetForUserAsync (downstreamWebApi, serviceName, relativePath, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.GetForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.GetForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TOutput></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TOutput">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="relativePath" Type="System.String" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TOutput">Output type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Get a strongly typed response from the web API.
</summary>
<returns>A strongly typed response from the web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PostForUserAsync<TOutput,TInput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<TOutput?> PostForUserAsync<TOutput,TInput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, TInput inputData, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default) where TOutput : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!TOutput> PostForUserAsync<class TOutput, TInput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, !!TInput inputData, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PostForUserAsync``2(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``1,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function PostForUserAsync(Of TOutput As Class, TInput As Class) (downstreamWebApi As IDownstreamWebApi, serviceName As String, relativePath As String, inputData As TInput, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task(Of TOutput)" />
<MemberSignature Language="F#" Value="static member PostForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * string * 'Input * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PostForUserAsync (downstreamWebApi, serviceName, relativePath, inputData, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.PostForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.PostForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TOutput></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TOutput">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TInput" />
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="relativePath" Type="System.String" />
<Parameter Name="inputData" Type="TInput" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TOutput">Output type.</typeparam>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Calls the web API with an HttpPost, providing strongly typed input and getting
strongly typed output.
</summary>
<returns>A strongly typed response from the web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PutForUserAsync<TInput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task PutForUserAsync<TInput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, TInput inputData, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task PutForUserAsync<TInput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, !!TInput inputData, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync``1(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``0,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function PutForUserAsync(Of TInput) (downstreamWebApi As IDownstreamWebApi, serviceName As String, relativePath As String, inputData As TInput, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task" />
<MemberSignature Language="F#" Value="static member PutForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * string * 'Input * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync (downstreamWebApi, serviceName, relativePath, inputData, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertFromInput<TInput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertFromInput<TInput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.PutForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.PutForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TInput" />
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="relativePath" Type="System.String" />
<Parameter Name="inputData" Type="TInput" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Calls the web API endpoint with an HttpPut, providing strongly typed input data.
</summary>
<returns>The value returned by the downstream web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PutForUserAsync<TOutput,TInput>">
<MemberSignature Language="C#" Value="public static System.Threading.Tasks.Task<TOutput?> PutForUserAsync<TOutput,TInput> (this Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, TInput inputData, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, string? authenticationScheme = default) where TOutput : class;" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class System.Threading.Tasks.Task`1<!!TOutput> PutForUserAsync<class TOutput, TInput>(class Microsoft.Identity.Web.IDownstreamWebApi downstreamWebApi, string serviceName, string relativePath, !!TInput inputData, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, string authenticationScheme) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync``2(Microsoft.Identity.Web.IDownstreamWebApi,System.String,System.String,``1,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.String)" />
<MemberSignature Language="VB.NET" Value="<Extension()>
Public Function PutForUserAsync(Of TOutput As Class, TInput As Class) (downstreamWebApi As IDownstreamWebApi, serviceName As String, relativePath As String, inputData As TInput, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional authenticationScheme As String = Nothing) As Task(Of TOutput)" />
<MemberSignature Language="F#" Value="static member PutForUserAsync : Microsoft.Identity.Web.IDownstreamWebApi * string * string * 'Input * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * string -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)" Usage="Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.PutForUserAsync (downstreamWebApi, serviceName, relativePath, inputData, downstreamWebApiOptionsOverride, user, authenticationScheme)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.18.1.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls Microsoft.Identity.Web.DownstreamWebApiGenericExtensions.ConvertToOutput<TOutput>(TInput).")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use IDownstreamApi.PutForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use IDownstreamApi.PutForUserAsync in Microsoft.Identity.Abstractions, implemented in Microsoft.Identity.Web.DownstreamApi.See aka.ms/id-web-downstream-api-v2 for migration details.", false)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TOutput></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TOutput">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
<TypeParameter Name="TInput" />
</TypeParameters>
<Parameters>
<Parameter Name="downstreamWebApi" Type="Microsoft.Identity.Web.IDownstreamWebApi" RefType="this" />
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="relativePath" Type="System.String" />
<Parameter Name="inputData" Type="TInput" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="authenticationScheme" Type="System.String" />
</Parameters>
<Docs>
<typeparam name="TOutput">Output type.</typeparam>
<typeparam name="TInput">Input type.</typeparam>
<param name="downstreamWebApi">The downstream web API.</param>
<param name="serviceName">Name of the service describing the downstream web API. There can
be several configuration named sections mapped to a <see cref="T:Microsoft.Identity.Web.DownstreamWebApiOptions" />,
each for one downstream web API. You can pass-in null, but in that case <paramref name="downstreamWebApiOptionsOverride" />
needs to be set.</param>
<param name="relativePath">Path to the API endpoint relative to the base URL specified in the configuration.</param>
<param name="inputData">Input data sent to the API.</param>
<param name="downstreamWebApiOptionsOverride">Overrides the options proposed in the configuration described
by <paramref name="serviceName" />.</param>
<param name="user">[Optional] Claims representing a user. This is useful in platforms like Blazor
or Azure Signal R, where the HttpContext is not available. In other platforms, the library
will find the user from the HttpContext.</param>
<param name="authenticationScheme">Authentication scheme. If null, will use OpenIdConnectDefault.AuthenticationScheme
if called from a web app, and JwtBearerDefault.AuthenticationScheme if called from a web API.</param>
<summary>
Calls the web API endpoint with an HttpPut, provinding strongly typed input data
and getting back strongly typed data.
</summary>
<returns>A strongly typed response from the web API.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>