-
Notifications
You must be signed in to change notification settings - Fork 25
/
GetAuthorizationRequestUrlParameterBuilder.xml
274 lines (274 loc) · 18.5 KB
/
GetAuthorizationRequestUrlParameterBuilder.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
<Type Name="GetAuthorizationRequestUrlParameterBuilder" FullName="Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder">
<TypeSignature Language="C#" Value="public sealed class GetAuthorizationRequestUrlParameterBuilder : Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder>" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi sealed beforefieldinit GetAuthorizationRequestUrlParameterBuilder extends Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder`1<class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder>" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" />
<TypeSignature Language="VB.NET" Value="Public NotInheritable Class GetAuthorizationRequestUrlParameterBuilder
Inherits AbstractConfidentialClientAcquireTokenParameterBuilder(Of GetAuthorizationRequestUrlParameterBuilder)" />
<TypeSignature Language="F#" Value="type GetAuthorizationRequestUrlParameterBuilder = class
 inherit AbstractConfidentialClientAcquireTokenParameterBuilder<GetAuthorizationRequestUrlParameterBuilder>" />
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.48.1.0</AssemblyVersion>
<AssemblyVersion>4.49.1.0</AssemblyVersion>
<AssemblyVersion>4.51.0.0</AssemblyVersion>
<AssemblyVersion>4.52.0.0</AssemblyVersion>
<AssemblyVersion>4.53.0.0</AssemblyVersion>
<AssemblyVersion>4.54.0.0</AssemblyVersion>
<AssemblyVersion>4.54.1.0</AssemblyVersion>
<AssemblyVersion>4.55.0.0</AssemblyVersion>
<AssemblyVersion>4.56.0.0</AssemblyVersion>
<AssemblyVersion>4.57.0.0</AssemblyVersion>
<AssemblyVersion>4.58.0.0</AssemblyVersion>
<AssemblyVersion>4.58.1.0</AssemblyVersion>
<AssemblyVersion>4.59.0.0</AssemblyVersion>
<AssemblyVersion>4.60.0.0</AssemblyVersion>
<AssemblyVersion>4.60.1.0</AssemblyVersion>
<AssemblyVersion>4.60.2.0</AssemblyVersion>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
<AssemblyVersion>4.61.0.0</AssemblyVersion>
<AssemblyVersion>4.61.1.0</AssemblyVersion>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Client.AbstractConfidentialClientAcquireTokenParameterBuilder<Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder></BaseTypeName>
<BaseTypeArguments>
<BaseTypeArgument TypeParamName="T">Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</BaseTypeArgument>
</BaseTypeArguments>
</Base>
<Interfaces />
<Docs>
<summary>
NOTE: a few of the methods in AbstractAcquireTokenParameterBuilder (e.g. account) don't make sense here.
Do we want to create a further base that contains ALL of the common methods, and then have another one including
account, etc
that are only used for AcquireToken?
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="ExecuteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Uri> ExecuteAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Uri> ExecuteAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync" />
<MemberSignature Language="VB.NET" Value="Public Function ExecuteAsync () As Task(Of Uri)" />
<MemberSignature Language="F#" Value="override this.ExecuteAsync : unit -> System.Threading.Tasks.Task<Uri>" Usage="getAuthorizationRequestUrlParameterBuilder.ExecuteAsync " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Uri></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary />
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ExecuteAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Uri> ExecuteAsync (System.Threading.CancellationToken cancellationToken);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Uri> ExecuteAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.ExecuteAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function ExecuteAsync (cancellationToken As CancellationToken) As Task(Of Uri)" />
<MemberSignature Language="F#" Value="override this.ExecuteAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<Uri>" Usage="getAuthorizationRequestUrlParameterBuilder.ExecuteAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Uri></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken" />
<summary />
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithAccount">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithAccount (Microsoft.Identity.Client.IAccount account);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithAccount(class Microsoft.Identity.Client.IAccount account) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithAccount(Microsoft.Identity.Client.IAccount)" />
<MemberSignature Language="VB.NET" Value="Public Function WithAccount (account As IAccount) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithAccount : Microsoft.Identity.Client.IAccount -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithAccount account" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
</Parameters>
<Docs>
<param name="account" />
<summary />
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithCcsRoutingHint">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithCcsRoutingHint (string userObjectIdentifier, string tenantIdentifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithCcsRoutingHint(string userObjectIdentifier, string tenantIdentifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithCcsRoutingHint(System.String,System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithCcsRoutingHint (userObjectIdentifier As String, tenantIdentifier As String) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithCcsRoutingHint : string * string -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithCcsRoutingHint (userObjectIdentifier, tenantIdentifier)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userObjectIdentifier" Type="System.String" />
<Parameter Name="tenantIdentifier" Type="System.String" />
</Parameters>
<Docs>
<param name="userObjectIdentifier">GUID which is unique to the user, parsed from the client_info.</param>
<param name="tenantIdentifier">GUID format of the tenant ID, parsed from the client_info.</param>
<summary>
To help with resiliency, the AAD backup authentication system operates as an AAD backup.
This will provide the AAD backup authentication system with a routing hint to help improve performance during authentication.
The hint created with this api will take precedence over the one created with <see cref="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)" /></summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithExtraScopesToConsent">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithExtraScopesToConsent (System.Collections.Generic.IEnumerable<string> extraScopesToConsent);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithExtraScopesToConsent(class System.Collections.Generic.IEnumerable`1<string> extraScopesToConsent) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent(System.Collections.Generic.IEnumerable{System.String})" />
<MemberSignature Language="VB.NET" Value="Public Function WithExtraScopesToConsent (extraScopesToConsent As IEnumerable(Of String)) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithExtraScopesToConsent : seq<string> -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithExtraScopesToConsent extraScopesToConsent" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="extraScopesToConsent" Type="System.Collections.Generic.IEnumerable<System.String>" />
</Parameters>
<Docs>
<param name="extraScopesToConsent" />
<summary />
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithLoginHint">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithLoginHint (string loginHint);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithLoginHint(string loginHint) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithLoginHint(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithLoginHint (loginHint As String) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithLoginHint : string -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithLoginHint loginHint" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="loginHint" Type="System.String" />
</Parameters>
<Docs>
<param name="loginHint" />
<summary />
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithPkce">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithPkce (out string codeVerifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithPkce([out] string& codeVerifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPkce(System.String@)" />
<MemberSignature Language="VB.NET" Value="Public Function WithPkce (ByRef codeVerifier As String) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithPkce : string -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithPkce codeVerifier" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="codeVerifier" Type="System.String" RefType="out" />
</Parameters>
<Docs>
<param name="codeVerifier">MSAL.NET will generate it. </param>
<summary>
Used to secure authorization code grant via Proof of Key for Code Exchange (PKCE).
For more information, see the PKCE RCF:
https://tools.ietf.org/html/rfc7636
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithPrompt">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithPrompt (Microsoft.Identity.Client.Prompt prompt);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithPrompt(valuetype Microsoft.Identity.Client.Prompt prompt) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithPrompt(Microsoft.Identity.Client.Prompt)" />
<MemberSignature Language="VB.NET" Value="Public Function WithPrompt (prompt As Prompt) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithPrompt : Microsoft.Identity.Client.Prompt -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithPrompt prompt" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="prompt" Type="Microsoft.Identity.Client.Prompt" />
</Parameters>
<Docs>
<param name="prompt">Requested interactive experience. The default is <see cref="F:Microsoft.Identity.Client.Prompt.SelectAccount" /></param>
<summary>
Specifies the interactive experience for the user.
</summary>
<returns>The builder to chain the .With methods</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="WithRedirectUri">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithRedirectUri (string redirectUri);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder WithRedirectUri(string redirectUri) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder.WithRedirectUri(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function WithRedirectUri (redirectUri As String) As GetAuthorizationRequestUrlParameterBuilder" />
<MemberSignature Language="F#" Value="member this.WithRedirectUri : string -> Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder" Usage="getAuthorizationRequestUrlParameterBuilder.WithRedirectUri redirectUri" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.61.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.GetAuthorizationRequestUrlParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="redirectUri" Type="System.String" />
</Parameters>
<Docs>
<param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
<summary>
Sets the redirect URI to add to the Authorization request URL
</summary>
<returns />
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>