-
Notifications
You must be signed in to change notification settings - Fork 27
/
DownstreamWebApi.xml
212 lines (212 loc) · 18.2 KB
/
DownstreamWebApi.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
<Type Name="DownstreamWebApi" FullName="Microsoft.Identity.Web.DownstreamWebApi">
<TypeSignature Language="C#" Value="public class DownstreamWebApi : Microsoft.Identity.Web.IDownstreamWebApi" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit DownstreamWebApi extends System.Object implements class Microsoft.Identity.Web.IDownstreamWebApi" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Web.DownstreamWebApi" />
<TypeSignature Language="VB.NET" Value="Public Class DownstreamWebApi
Implements IDownstreamWebApi" />
<TypeSignature Language="F#" Value="type DownstreamWebApi = class
 interface IDownstreamWebApi" />
<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>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Identity.Web.IDownstreamWebApi</InterfaceName>
</Interface>
</Interfaces>
<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.Obsolete("Use DownstreamApi 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 DownstreamApi 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>
<Docs>
<summary>
Implementation for the downstream web API.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DownstreamWebApi (Microsoft.Identity.Web.ITokenAcquisition tokenAcquisition, Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.DownstreamWebApiOptions> namedDownstreamWebApiOptions, System.Net.Http.HttpClient httpClient, Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.MicrosoftIdentityOptions> microsoftIdentityOptionsMonitor);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.Identity.Web.ITokenAcquisition tokenAcquisition, class Microsoft.Extensions.Options.IOptionsMonitor`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> namedDownstreamWebApiOptions, class System.Net.Http.HttpClient httpClient, class Microsoft.Extensions.Options.IOptionsMonitor`1<class Microsoft.Identity.Web.MicrosoftIdentityOptions> microsoftIdentityOptionsMonitor) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApi.#ctor(Microsoft.Identity.Web.ITokenAcquisition,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.HttpClient,Microsoft.Extensions.Options.IOptionsMonitor{Microsoft.Identity.Web.MicrosoftIdentityOptions})" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tokenAcquisition As ITokenAcquisition, namedDownstreamWebApiOptions As IOptionsMonitor(Of DownstreamWebApiOptions), httpClient As HttpClient, microsoftIdentityOptionsMonitor As IOptionsMonitor(Of MicrosoftIdentityOptions))" />
<MemberSignature Language="F#" Value="new Microsoft.Identity.Web.DownstreamWebApi : Microsoft.Identity.Web.ITokenAcquisition * Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Net.Http.HttpClient * Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.MicrosoftIdentityOptions> -> Microsoft.Identity.Web.DownstreamWebApi" Usage="new Microsoft.Identity.Web.DownstreamWebApi (tokenAcquisition, namedDownstreamWebApiOptions, httpClient, microsoftIdentityOptionsMonitor)" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tokenAcquisition" Type="Microsoft.Identity.Web.ITokenAcquisition" />
<Parameter Name="namedDownstreamWebApiOptions" Type="Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="httpClient" Type="System.Net.Http.HttpClient" />
<Parameter Name="microsoftIdentityOptionsMonitor" Type="Microsoft.Extensions.Options.IOptionsMonitor<Microsoft.Identity.Web.MicrosoftIdentityOptions>" />
</Parameters>
<Docs>
<param name="tokenAcquisition">Token acquisition service.</param>
<param name="namedDownstreamWebApiOptions">Named options provider.</param>
<param name="httpClient">HTTP client.</param>
<param name="microsoftIdentityOptionsMonitor">Configuration options.</param>
<summary>
Constructor.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CallWebApiForAppAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallWebApiForAppAsync (string serviceName, string? authenticationScheme, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Net.Http.StringContent? content = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Net.Http.HttpResponseMessage> CallWebApiForAppAsync(string serviceName, string authenticationScheme, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Net.Http.StringContent content) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForAppAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.StringContent)" />
<MemberSignature Language="VB.NET" Value="Public Function CallWebApiForAppAsync (serviceName As String, authenticationScheme As String, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional content As StringContent = Nothing) As Task(Of HttpResponseMessage)" />
<MemberSignature Language="F#" Value="abstract member CallWebApiForAppAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
override this.CallWebApiForAppAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>" Usage="downstreamWebApi.CallWebApiForAppAsync (serviceName, authenticationScheme, downstreamWebApiOptionsOverride, content)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForAppAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Net.Http.StringContent)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="authenticationScheme" Type="System.String" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="content" Type="System.Net.Http.StringContent" />
</Parameters>
<Docs>
<param name="serviceName">To be added.</param>
<param name="authenticationScheme">To be added.</param>
<param name="downstreamWebApiOptionsOverride">To be added.</param>
<param name="content">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="CallWebApiForUserAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage> CallWebApiForUserAsync (string serviceName, string? authenticationScheme, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? calledDownstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default, System.Net.Http.StringContent? content = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Net.Http.HttpResponseMessage> CallWebApiForUserAsync(string serviceName, string authenticationScheme, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> calledDownstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user, class System.Net.Http.StringContent content) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForUserAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.Net.Http.StringContent)" />
<MemberSignature Language="VB.NET" Value="Public Function CallWebApiForUserAsync (serviceName As String, authenticationScheme As String, Optional calledDownstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing, Optional content As StringContent = Nothing) As Task(Of HttpResponseMessage)" />
<MemberSignature Language="F#" Value="abstract member CallWebApiForUserAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>
override this.CallWebApiForUserAsync : string * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal * System.Net.Http.StringContent -> System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage>" Usage="downstreamWebApi.CallWebApiForUserAsync (serviceName, authenticationScheme, calledDownstreamWebApiOptionsOverride, user, content)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync(System.String,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal,System.Net.Http.StringContent)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Net.Http.HttpResponseMessage></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="authenticationScheme" Type="System.String" />
<Parameter Name="calledDownstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
<Parameter Name="content" Type="System.Net.Http.StringContent" />
</Parameters>
<Docs>
<param name="serviceName">To be added.</param>
<param name="authenticationScheme">To be added.</param>
<param name="calledDownstreamWebApiOptionsOverride">To be added.</param>
<param name="user">To be added.</param>
<param name="content">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="CallWebApiForUserAsync<TInput,TOutput>">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<TOutput?> CallWebApiForUserAsync<TInput,TOutput> (string serviceName, TInput input, string? authenticationScheme, Action<Microsoft.Identity.Web.DownstreamWebApiOptions>? downstreamWebApiOptionsOverride = default, System.Security.Claims.ClaimsPrincipal? user = default) where TOutput : class;" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<!!TOutput> CallWebApiForUserAsync<TInput, class TOutput>(string serviceName, !!TInput input, string authenticationScheme, class System.Action`1<class Microsoft.Identity.Web.DownstreamWebApiOptions> downstreamWebApiOptionsOverride, class System.Security.Claims.ClaimsPrincipal user) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Web.DownstreamWebApi.CallWebApiForUserAsync``2(System.String,``0,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal)" />
<MemberSignature Language="VB.NET" Value="Public Function CallWebApiForUserAsync(Of TInput, TOutput) (serviceName As String, input As TInput, authenticationScheme As String, Optional downstreamWebApiOptionsOverride As Action(Of DownstreamWebApiOptions) = Nothing, Optional user As ClaimsPrincipal = Nothing) As Task(Of TOutput)" />
<MemberSignature Language="F#" Value="abstract member CallWebApiForUserAsync : string * 'Input * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)
override this.CallWebApiForUserAsync : string * 'Input * string * Action<Microsoft.Identity.Web.DownstreamWebApiOptions> * System.Security.Claims.ClaimsPrincipal -> System.Threading.Tasks.Task<'Output (requires 'Output : null)> (requires 'Output : null)" Usage="downstreamWebApi.CallWebApiForUserAsync (serviceName, input, authenticationScheme, downstreamWebApiOptionsOverride, user)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Web.IDownstreamWebApi.CallWebApiForUserAsync``2(System.String,``0,System.String,System.Action{Microsoft.Identity.Web.DownstreamWebApiOptions},System.Security.Claims.ClaimsPrincipal)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Web</AssemblyName>
<AssemblyVersion>2.20.0.0</AssemblyVersion>
</AssemblyInfo>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions).")]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.CodeAnalysis.RequiresUnreferencedCode("Calls System.Text.Json.JsonSerializer.Serialize<TValue>(TValue, JsonSerializerOptions).")>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<TOutput></ReturnType>
</ReturnValue>
<TypeParameters>
<TypeParameter Name="TInput" />
<TypeParameter Name="TOutput">
<Constraints>
<ParameterAttribute>ReferenceTypeConstraint</ParameterAttribute>
</Constraints>
</TypeParameter>
</TypeParameters>
<Parameters>
<Parameter Name="serviceName" Type="System.String" />
<Parameter Name="input" Type="TInput" />
<Parameter Name="authenticationScheme" Type="System.String" />
<Parameter Name="downstreamWebApiOptionsOverride" Type="System.Action<Microsoft.Identity.Web.DownstreamWebApiOptions>" />
<Parameter Name="user" Type="System.Security.Claims.ClaimsPrincipal" />
</Parameters>
<Docs>
<typeparam name="TInput">To be added.</typeparam>
<typeparam name="TOutput">To be added.</typeparam>
<param name="serviceName">To be added.</param>
<param name="input">To be added.</param>
<param name="authenticationScheme">To be added.</param>
<param name="downstreamWebApiOptionsOverride">To be added.</param>
<param name="user">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
</Members>
</Type>