-
Notifications
You must be signed in to change notification settings - Fork 32
/
ClientApplicationBase.xml
897 lines (890 loc) Β· 64.8 KB
/
ClientApplicationBase.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
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
<Type Name="ClientApplicationBase" FullName="Microsoft.Identity.Client.ClientApplicationBase">
<TypeSignature Language="C#" Value="public abstract class ClientApplicationBase : Microsoft.Identity.Client.ApplicationBase, Microsoft.Identity.Client.IClientApplicationBase" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit ClientApplicationBase extends Microsoft.Identity.Client.ApplicationBase implements class Microsoft.Identity.Client.IApplicationBase, class Microsoft.Identity.Client.IClientApplicationBase" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.ClientApplicationBase" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class ClientApplicationBase
Inherits ApplicationBase
Implements IClientApplicationBase" />
<TypeSignature Language="F#" Value="type ClientApplicationBase = class
 inherit ApplicationBase
 interface IClientApplicationBase
 interface IApplicationBase" />
<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>
<AssemblyVersion>4.62.0.0</AssemblyVersion>
<AssemblyVersion>4.63.0.0</AssemblyVersion>
<AssemblyVersion>4.64.0.0</AssemblyVersion>
<AssemblyVersion>4.64.1.0</AssemblyVersion>
<AssemblyVersion>4.65.0.0</AssemblyVersion>
<AssemblyVersion>4.66.0.0</AssemblyVersion>
<AssemblyVersion>4.66.1.0</AssemblyVersion>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>Microsoft.Identity.Client.ApplicationBase</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Microsoft.Identity.Client.IApplicationBase</InterfaceName>
</Interface>
<Interface>
<InterfaceName>Microsoft.Identity.Client.IClientApplicationBase</InterfaceName>
</Interface>
</Interfaces>
<Docs>
<summary>
Abstract class containing common API methods and properties. Both <see cref="T:Microsoft.Identity.Client.PublicClientApplication" /> and
ConfidentialClientApplication
extend this class. For details see https://aka.ms/msal-net-client-applications
</summary>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
<Members>
<Member MemberName="AcquireTokenSilent">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.IAccount account);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent(class System.Collections.Generic.IEnumerable`1<string> scopes, class Microsoft.Identity.Client.IAccount account) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenSilent (scopes As IEnumerable(Of String), account As IAccount) As AcquireTokenSilentParameterBuilder" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenSilent : seq<string> * Microsoft.Identity.Client.IAccount -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder
override this.AcquireTokenSilent : seq<string> * Microsoft.Identity.Client.IAccount -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder" Usage="clientApplicationBase.AcquireTokenSilent (scopes, account)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API</param>
<param name="account">Account for which the token is requested.</param>
<summary>
[V3 API] Attempts to acquire an access token for the <paramref name="account" /> from the user token cache.
See https://aka.ms/msal-net-acquiretokensilent for more details
</summary>
<returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder" /> used to build the token request, adding optional
parameters</returns>
<remarks>
The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than
requested could be returned. If the access token is expired or close to expiration - within a 5 minute window -
then the cached refresh token (if available) is used to acquire a new access token by making a silent network call.
You can set additional parameters by chaining the builder with:
<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)" />
to request a token for a different authority than the one set at the application construction
<see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)" /> to bypass the user token cache and
force refreshing the token, as well as
<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})" /> to
specify extra query parameters
</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application,
for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired),
or the user needs to perform two factor authentication</exception>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="AcquireTokenSilent">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent (System.Collections.Generic.IEnumerable<string> scopes, string loginHint);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder AcquireTokenSilent(class System.Collections.Generic.IEnumerable`1<string> scopes, string loginHint) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenSilent (scopes As IEnumerable(Of String), loginHint As String) As AcquireTokenSilentParameterBuilder" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenSilent : seq<string> * string -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder
override this.AcquireTokenSilent : seq<string> * string -> Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder" Usage="clientApplicationBase.AcquireTokenSilent (scopes, loginHint)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="loginHint" Type="System.String" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API</param>
<param name="loginHint">Typically the username, in UPN format, e.g. [email protected] </param>
<summary>
[V3 API] Attempts to acquire an access token for the <see cref="T:Microsoft.Identity.Client.IAccount" />
having the <see cref="P:Microsoft.Identity.Client.IAccount.Username" /> match the given <paramref name="loginHint" />, from the user token cache.
See https://aka.ms/msal-net-acquiretokensilent for more details
</summary>
<returns>An <see cref="T:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder" /> used to build the token request, adding optional
parameters</returns>
<remarks>
If multiple <see cref="T:Microsoft.Identity.Client.IAccount" /> match the <paramref name="loginHint" />, or if there are no matches, an exception is thrown.
The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than
requested could be returned. If the access token is expired or close to expiration - within a 5 minute window -
then the cached refresh token (if available) is used to acquire a new access token by making a silent network call.
You can set additional parameters by chaining the builder with:
<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithTenantId(System.String)" /> to request a token for a different authority than the one set at the application construction
<see cref="M:Microsoft.Identity.Client.AcquireTokenSilentParameterBuilder.WithForceRefresh(System.Boolean)" /> to bypass the user token cache and
force refreshing the token, as well as
<see cref="M:Microsoft.Identity.Client.AbstractAcquireTokenParameterBuilder`1.WithExtraQueryParameters(System.Collections.Generic.Dictionary{System.String,System.String})" /> to
specify extra query parameters
</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">will be thrown in the case where an interaction is required with the end user of the application,
for instance, if no refresh token was in the cache, or the user needs to consent, or re-sign-in (for instance if the password expired),
or the user needs to perform two factor authentication</exception>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="AcquireTokenSilentAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenSilentAsync (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.IAccount account);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenSilentAsync(class System.Collections.Generic.IEnumerable`1<string> scopes, class Microsoft.Identity.Client.IAccount account) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenSilentAsync (scopes As IEnumerable(Of String), account As IAccount) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenSilentAsync : seq<string> * Microsoft.Identity.Client.IAccount -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>
override this.AcquireTokenSilentAsync : seq<string> * Microsoft.Identity.Client.IAccount -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="clientApplicationBase.AcquireTokenSilentAsync (scopes, account)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use AcquireTokenSilent instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenSilent instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API</param>
<param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount" /></param>
<summary>
[V2 API] Attempts to acquire an access token for the <paramref name="account" /> from the user token cache.
</summary>
<returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult" /> containing the requested token</returns>
<remarks>
The access token is considered a match if it contains <b>at least</b> all the requested scopes.
This means that an access token with more scopes than requested could be returned as well. If the access token is expired or
close to expiration (within a 5 minute window), then the cached refresh token (if available) is used to acquire a new access token by making a silent network call.
See https://aka.ms/msal-net-acquiretokensilent for more details
</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application,
for instance so that the user consents, or re-signs-in (for instance if the password expired), or performs two factor authentication</exception>
</Docs>
</Member>
<Member MemberName="AcquireTokenSilentAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult> AcquireTokenSilentAsync (System.Collections.Generic.IEnumerable<string> scopes, Microsoft.Identity.Client.IAccount account, string authority, bool forceRefresh);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.AuthenticationResult> AcquireTokenSilentAsync(class System.Collections.Generic.IEnumerable`1<string> scopes, class Microsoft.Identity.Client.IAccount account, string authority, bool forceRefresh) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)" />
<MemberSignature Language="VB.NET" Value="Public Function AcquireTokenSilentAsync (scopes As IEnumerable(Of String), account As IAccount, authority As String, forceRefresh As Boolean) As Task(Of AuthenticationResult)" />
<MemberSignature Language="F#" Value="abstract member AcquireTokenSilentAsync : seq<string> * Microsoft.Identity.Client.IAccount * string * bool -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>
override this.AcquireTokenSilentAsync : seq<string> * Microsoft.Identity.Client.IAccount * string * bool -> System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult>" Usage="clientApplicationBase.AcquireTokenSilentAsync (scopes, account, authority, forceRefresh)" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.AcquireTokenSilentAsync(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount,System.String,System.Boolean)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use AcquireTokenSilent instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AcquireTokenSilent instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.AuthenticationResult></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="scopes" Type="System.Collections.Generic.IEnumerable<System.String>" />
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
<Parameter Name="authority" Type="System.String" />
<Parameter Name="forceRefresh" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="scopes">Scopes requested to access a protected API</param>
<param name="account">Account for which the token is requested. <see cref="T:Microsoft.Identity.Client.IAccount" /></param>
<param name="authority">Specific authority for which the token is requested. Passing a different value than configured in the application constructor
narrows down the selection to a specific tenant. This does not change the configured value in the application. This is specific
to applications managing several accounts (like a mail client with several mailboxes)</param>
<param name="forceRefresh">If <c>true</c>, ignore any access token in the cache and attempt to acquire new access token
using the refresh token for the account if this one is available. This can be useful in the case when the application developer wants to make
sure that conditional access policies are applied immediately, rather than after the expiration of the access token</param>
<summary>
[V2 API] Attempts to acquire an access token for the <paramref name="account" /> from the user token cache, with advanced parameters controlling network call.
</summary>
<returns>An <see cref="T:Microsoft.Identity.Client.AuthenticationResult" /> containing the requested access token</returns>
<remarks>
The access token is considered a match if it contains <b>at least</b> all the requested scopes. This means that an access token with more scopes than
requested could be returned as well. If the access token is expired or close to expiration (within a 5 minute window),
then the cached refresh token (if available) is used to acquire a new access token by making a silent network call.
See https://aka.ms/msal-net-acquiretokensilent for more details
</remarks>
<exception cref="T:Microsoft.Identity.Client.MsalUiRequiredException">can be thrown in the case where an interaction is required with the end user of the application,
for instance, if no refresh token was in the cache,a or the user needs to consent, or re-sign-in (for instance if the password expired),
or performs two factor authentication</exception>
</Docs>
</Member>
<Member MemberName="AppConfig">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.IAppConfig AppConfig { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Client.IAppConfig AppConfig" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.AppConfig" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property AppConfig As IAppConfig" />
<MemberSignature Language="F#" Value="member this.AppConfig : Microsoft.Identity.Client.IAppConfig" Usage="Microsoft.Identity.Client.ClientApplicationBase.AppConfig" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.AppConfig</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.IAppConfig</ReturnType>
</ReturnValue>
<Docs>
<summary>
Details on the configuration of the ClientApplication for debugging purposes.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Authority">
<MemberSignature Language="C#" Value="public string Authority { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Authority" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.Authority" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Authority As String" />
<MemberSignature Language="F#" Value="member this.Authority : string" Usage="Microsoft.Identity.Client.ClientApplicationBase.Authority" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.Authority</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the URL of the authority, or security token service (STS) from which MSAL.NET will acquire security tokens
The return value of this property is either the value provided by the developer in the constructor of the application, or otherwise
the value of the <see cref="F:Microsoft.Identity.Client.ApplicationBase.DefaultAuthority" /> static member (that is <c>https://login.microsoftonline.com/common/</c>)
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ClientId">
<MemberSignature Language="C#" Value="public string ClientId { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string ClientId" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.ClientId" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property ClientId As String" />
<MemberSignature Language="F#" Value="member this.ClientId : string" Usage="Microsoft.Identity.Client.ClientApplicationBase.ClientId" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.ClientId</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use AppConfig.ClientId instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use AppConfig.ClientId instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the Client ID (also known as <i>Application ID</i>) of the application as registered in the application registration portal (https://aka.ms/msal-net-register-app)
and as passed in the constructor of the application
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Component">
<MemberSignature Language="C#" Value="public string Component { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Component" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.Component" />
<MemberSignature Language="VB.NET" Value="Public Property Component As String" />
<MemberSignature Language="F#" Value="member this.Component : string with get, set" Usage="Microsoft.Identity.Client.ClientApplicationBase.Component" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.Component</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use WithComponent on AbstractApplicationBuilder<T> to configure this instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use WithComponent on AbstractApplicationBuilder<T> to configure this instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Identifier of the component (libraries/SDK) consuming MSAL.NET.
This will allow for disambiguation between MSAL usage by the app vs MSAL usage by component libraries.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAccountAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount> GetAccountAsync (string accountId);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.IAccount> GetAccountAsync(string accountId) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountAsync (accountId As String) As Task(Of IAccount)" />
<MemberSignature Language="F#" Value="abstract member GetAccountAsync : string -> System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount>
override this.GetAccountAsync : string -> System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount>" Usage="clientApplicationBase.GetAccountAsync accountId" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountAsync(System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="accountId" Type="System.String" />
</Parameters>
<Docs>
<param name="accountId">Account identifier. The identifier is typically the
value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier" /> property of <see cref="T:Microsoft.Identity.Client.AccountId" />.
You typically get the account ID from an <see cref="T:Microsoft.Identity.Client.IAccount" /> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId" /> property>
</param>
<summary>
Get the <see cref="T:Microsoft.Identity.Client.IAccount" /> by its identifier among the accounts available in the token cache.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetAccountAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount> GetAccountAsync (string accountId, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class Microsoft.Identity.Client.IAccount> GetAccountAsync(string accountId, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountAsync (accountId As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IAccount)" />
<MemberSignature Language="F#" Value="member this.GetAccountAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount>" Usage="clientApplicationBase.GetAccountAsync (accountId, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<Microsoft.Identity.Client.IAccount></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="accountId" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="accountId">Account identifier. The identifier is typically the
value of the <see cref="P:Microsoft.Identity.Client.AccountId.Identifier" /> property of <see cref="T:Microsoft.Identity.Client.AccountId" />.
You typically get the account ID from an <see cref="T:Microsoft.Identity.Client.IAccount" /> by using the <see cref="P:Microsoft.Identity.Client.IAccount.HomeAccountId" /> property>
</param>
<param name="cancellationToken">Cancellation token </param>
<summary>
Get the <see cref="T:Microsoft.Identity.Client.IAccount" /> by its identifier among the accounts available in the token cache.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAccountsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>> GetAccountsAsync ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Identity.Client.IAccount>> GetAccountsAsync() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountsAsync () As Task(Of IEnumerable(Of IAccount))" />
<MemberSignature Language="F#" Value="abstract member GetAccountsAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>
override this.GetAccountsAsync : unit -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>" Usage="clientApplicationBase.GetAccountsAsync " />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>></ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>
Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetAccountsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>> GetAccountsAsync (string userFlow);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Identity.Client.IAccount>> GetAccountsAsync(string userFlow) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountsAsync (userFlow As String) As Task(Of IEnumerable(Of IAccount))" />
<MemberSignature Language="F#" Value="abstract member GetAccountsAsync : string -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>
override this.GetAccountsAsync : string -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>" Usage="clientApplicationBase.GetAccountsAsync userFlow" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.GetAccountsAsync(System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userFlow" Type="System.String" />
</Parameters>
<Docs>
<param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>.
</param>
<summary>
Get the <see cref="T:Microsoft.Identity.Client.IAccount" /> collection by its identifier among the accounts available in the token cache,
based on the user flow. This is for Azure AD B2C scenarios.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="GetAccountsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>> GetAccountsAsync (System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Identity.Client.IAccount>> GetAccountsAsync(valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountsAsync (Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of IAccount))" />
<MemberSignature Language="F#" Value="member this.GetAccountsAsync : System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>" Usage="clientApplicationBase.GetAccountsAsync cancellationToken" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="cancellationToken">To be added.</param>
<summary>
Returns all the available <see cref="T:Microsoft.Identity.Client.IAccount">accounts</see> in the user token cache for the application.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetAccountsAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>> GetAccountsAsync (string userFlow, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task`1<class System.Collections.Generic.IEnumerable`1<class Microsoft.Identity.Client.IAccount>> GetAccountsAsync(string userFlow, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync(System.String,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function GetAccountsAsync (userFlow As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of IEnumerable(Of IAccount))" />
<MemberSignature Language="F#" Value="member this.GetAccountsAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<seq<Microsoft.Identity.Client.IAccount>>" Usage="clientApplicationBase.GetAccountsAsync (userFlow, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task<System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IAccount>></ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="userFlow" Type="System.String" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="userFlow">The identifier is the user flow being targeted by the specific B2C authority/>.
</param>
<param name="cancellationToken">Cancellation token </param>
<summary>
Get the <see cref="T:Microsoft.Identity.Client.IAccount" /> collection by its identifier among the accounts available in the token cache,
based on the user flow. This is for Azure AD B2C scenarios.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetUser">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.IUser GetUser (string identifier);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.Identity.Client.IUser GetUser(string identifier) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.GetUser(System.String)" />
<MemberSignature Language="VB.NET" Value="Public Function GetUser (identifier As String) As IUser" />
<MemberSignature Language="F#" Value="abstract member GetUser : string -> Microsoft.Identity.Client.IUser
override this.GetUser : string -> Microsoft.Identity.Client.IUser" Usage="clientApplicationBase.GetUser identifier" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.GetUser(System.String)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use GetAccountAsync instead and pass IAccount.HomeAccountId.Identifier (See https://aka.ms/msal-net-2-released)", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use GetAccountAsync instead and pass IAccount.HomeAccountId.Identifier (See https://aka.ms/msal-net-2-released)", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.IUser</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="identifier" Type="System.String" />
</Parameters>
<Docs>
<param name="identifier">Identifier of the user to retrieve</param>
<summary>
In MSAL 1.x, return a user from its identifier. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync" /> instead.
See https://aka.ms/msal-net-2-released for more details.
</summary>
<returns>the user in the cache with the identifier passed as an argument</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RedirectUri">
<MemberSignature Language="C#" Value="public string RedirectUri { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string RedirectUri" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.RedirectUri" />
<MemberSignature Language="VB.NET" Value="Public Property RedirectUri As String" />
<MemberSignature Language="F#" Value="member this.RedirectUri : string with get, set" Usage="Microsoft.Identity.Client.ClientApplicationBase.RedirectUri" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.RedirectUri</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Should be set using AbstractApplicationBuilder<T>.WithRedirectUri and can be viewed with ClientApplicationBase.AppConfig.RedirectUri.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Should be set using AbstractApplicationBuilder<T>.WithRedirectUri and can be viewed with ClientApplicationBase.AppConfig.RedirectUri.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The redirect URI (also known as Reply URI or Reply URL), is the URI at which Azure AD will contact back the application with the tokens.
This redirect URI needs to be registered in the app registration (https://aka.ms/msal-net-register-app).
In MSAL.NET, <see cref="T:PublicClientApplication" /> define the following default RedirectUri values:
<list type="bullet"><item><description><c>https://login.microsoftonline.com/common/oauth2/nativeclient</c> for desktop (.NET Framework and .NET Core) applications</description></item><item><description><c>msal{ClientId}</c> for Xamarin iOS and Xamarin Android (as this will be used by the system web browser by default on these
platforms to call back the application)
</description></item></list>
These default URIs could change in the future.
In Microsoft.Identity.Client.ConfidentialClientApplication, this can be the URL of the web application / web API.
</summary>
<value>To be added.</value>
<remarks>This is especially important when you deploy an application that you have initially tested locally;
you then need to add the reply URL of the deployed application in the application registration portal</remarks>
</Docs>
</Member>
<Member MemberName="Remove">
<MemberSignature Language="C#" Value="public void Remove (Microsoft.Identity.Client.IUser user);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Remove(class Microsoft.Identity.Client.IUser user) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)" />
<MemberSignature Language="VB.NET" Value="Public Sub Remove (user As IUser)" />
<MemberSignature Language="F#" Value="abstract member Remove : Microsoft.Identity.Client.IUser -> unit
override this.Remove : Microsoft.Identity.Client.IUser -> unit" Usage="clientApplicationBase.Remove user" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.Remove(Microsoft.Identity.Client.IUser)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use RemoveAccountAsync instead (See https://aka.ms/msal-net-2-released)", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use RemoveAccountAsync instead (See https://aka.ms/msal-net-2-released)", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="user" Type="Microsoft.Identity.Client.IUser" />
</Parameters>
<Docs>
<param name="user">User to remove from the cache</param>
<summary>
In MSAL 1.x removed a user from the cache. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)" /> instead.
See https://aka.ms/msal-net-2-released for more details.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveAsync (Microsoft.Identity.Client.IAccount account);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task RemoveAsync(class Microsoft.Identity.Client.IAccount account) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)" />
<MemberSignature Language="VB.NET" Value="Public Function RemoveAsync (account As IAccount) As Task" />
<MemberSignature Language="F#" Value="abstract member RemoveAsync : Microsoft.Identity.Client.IAccount -> System.Threading.Tasks.Task
override this.RemoveAsync : Microsoft.Identity.Client.IAccount -> System.Threading.Tasks.Task" Usage="clientApplicationBase.RemoveAsync account" />
<MemberType>Method</MemberType>
<Implements>
<InterfaceMember>M:Microsoft.Identity.Client.IClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount)</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
</Parameters>
<Docs>
<param name="account">Instance of the account that needs to be removed</param>
<summary>
Removes all tokens in the cache for the specified account.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RemoveAsync">
<MemberSignature Language="C#" Value="public System.Threading.Tasks.Task RemoveAsync (Microsoft.Identity.Client.IAccount account, System.Threading.CancellationToken cancellationToken = default);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance class System.Threading.Tasks.Task RemoveAsync(class Microsoft.Identity.Client.IAccount account, valuetype System.Threading.CancellationToken cancellationToken) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.ClientApplicationBase.RemoveAsync(Microsoft.Identity.Client.IAccount,System.Threading.CancellationToken)" />
<MemberSignature Language="VB.NET" Value="Public Function RemoveAsync (account As IAccount, Optional cancellationToken As CancellationToken = Nothing) As Task" />
<MemberSignature Language="F#" Value="member this.RemoveAsync : Microsoft.Identity.Client.IAccount * System.Threading.CancellationToken -> System.Threading.Tasks.Task" Usage="clientApplicationBase.RemoveAsync (account, cancellationToken)" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="account" Type="Microsoft.Identity.Client.IAccount" />
<Parameter Name="cancellationToken" Type="System.Threading.CancellationToken" />
</Parameters>
<Docs>
<param name="account">Instance of the account that needs to be removed</param>
<param name="cancellationToken">Cancellation token</param>
<summary>
Removes all tokens in the cache for the specified account.
</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SliceParameters">
<MemberSignature Language="C#" Value="public string SliceParameters { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string SliceParameters" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.SliceParameters" />
<MemberSignature Language="VB.NET" Value="Public Property SliceParameters As String" />
<MemberSignature Language="F#" Value="member this.SliceParameters : string with get, set" Usage="Microsoft.Identity.Client.ClientApplicationBase.SliceParameters" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.SliceParameters</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Use ExtraQueryParameters on each call instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use ExtraQueryParameters on each call instead.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Sets or Gets a custom query parameters that may be sent to the STS for dogfood testing or debugging. This is a string of segments
of the form <c>key=value</c> separated by an ampersand character.
Unless requested otherwise, this parameter should not be set by application developers as it may have adverse effect on the application.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Users">
<MemberSignature Language="C#" Value="public System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IUser> Users { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Collections.Generic.IEnumerable`1<class Microsoft.Identity.Client.IUser> Users" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.Users" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property Users As IEnumerable(Of IUser)" />
<MemberSignature Language="F#" Value="member this.Users : seq<Microsoft.Identity.Client.IUser>" Usage="Microsoft.Identity.Client.ClientApplicationBase.Users" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.Users</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)]</AttributeName>
<AttributeName Language="F#">[<System.Diagnostics.DebuggerBrowsable(System.Diagnostics.DebuggerBrowsableState.Never)>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Obsolete("Use GetAccountsAsync instead (See https://aka.ms/msal-net-2-released)", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Use GetAccountsAsync instead (See https://aka.ms/msal-net-2-released)", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Collections.Generic.IEnumerable<Microsoft.Identity.Client.IUser></ReturnType>
</ReturnValue>
<Docs>
<summary>
In MSAL 1.x returned an enumeration of <see cref="T:Microsoft.Identity.Client.IUser" />. From MSAL 2.x, use <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.GetAccountsAsync" /> instead.
See https://aka.ms/msal-net-2-released for more details.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="UserTokenCache">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.ITokenCache UserTokenCache { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Client.ITokenCache UserTokenCache" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.UserTokenCache" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property UserTokenCache As ITokenCache" />
<MemberSignature Language="F#" Value="member this.UserTokenCache : Microsoft.Identity.Client.ITokenCache" Usage="Microsoft.Identity.Client.ClientApplicationBase.UserTokenCache" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:Microsoft.Identity.Client.IClientApplicationBase.UserTokenCache</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.ITokenCache</ReturnType>
</ReturnValue>
<Docs>
<summary>
User token cache. It holds access tokens, id tokens and refresh tokens for accounts. It's used
and updated silently if needed when calling <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)" />
or one of the overrides of <see cref="M:Microsoft.Identity.Client.ClientApplicationBase.AcquireTokenSilent(System.Collections.Generic.IEnumerable{System.String},Microsoft.Identity.Client.IAccount)" />.
It is updated by each AcquireTokenXXX method, with the exception of <c>AcquireTokenForClient</c> which only uses the application
cache (see <c>IConfidentialClientApplication</c>).
</summary>
<value>To be added.</value>
<remarks>On .NET Framework and .NET Core you can also customize the token cache serialization.
See https://aka.ms/msal-net-token-cache-serialization. This is taken care of by MSAL.NET on mobile platforms and on UWP.
It is recommended to use token cache serialization for web site and web api scenarios.
</remarks>
<inheritdoc />
</Docs>
</Member>
<Member MemberName="ValidateAuthority">
<MemberSignature Language="C#" Value="public bool ValidateAuthority { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ValidateAuthority" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.ClientApplicationBase.ValidateAuthority" />
<MemberSignature Language="VB.NET" Value="Public Property ValidateAuthority As Boolean" />
<MemberSignature Language="F#" Value="member this.ValidateAuthority : bool with get, set" Usage="Microsoft.Identity.Client.ClientApplicationBase.ValidateAuthority" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.66.2.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.Obsolete("Can be set on AbstractApplicationBuilder<T>.WithAuthority as needed.See https://aka.ms/msal-net-3-breaking-changes. ", true)]</AttributeName>
<AttributeName Language="F#">[<System.Obsolete("Can be set on AbstractApplicationBuilder<T>.WithAuthority as needed.See https://aka.ms/msal-net-3-breaking-changes. ", true)>]</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets/sets a boolean value telling the application if the authority needs to be verified against a list of known authorities. The default
value is <c>true</c>. It should currently be set to <c>false</c> for Azure AD B2C authorities as those are customer specific
(a list of known B2C authorities cannot be maintained by MSAL.NET). This property can be set just after the construction of the application
and before an operation acquiring a token or interacting with the STS.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>