/
AuthenticationResultMetadata.xml
295 lines (295 loc) · 16.4 KB
/
AuthenticationResultMetadata.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
<Type Name="AuthenticationResultMetadata" FullName="Microsoft.Identity.Client.AuthenticationResultMetadata">
<TypeSignature Language="C#" Value="public class AuthenticationResultMetadata" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit AuthenticationResultMetadata extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Identity.Client.AuthenticationResultMetadata" />
<TypeSignature Language="VB.NET" Value="Public Class AuthenticationResultMetadata" />
<TypeSignature Language="F#" Value="type AuthenticationResultMetadata = class" />
<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>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
Contains metadata of the authentication result. <see cref="T:Microsoft.Identity.Client.Metrics" /> for additional MSAL-wide metrics.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public AuthenticationResultMetadata (Microsoft.Identity.Client.TokenSource tokenSource);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Microsoft.Identity.Client.TokenSource tokenSource) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Identity.Client.AuthenticationResultMetadata.#ctor(Microsoft.Identity.Client.TokenSource)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (tokenSource As TokenSource)" />
<MemberSignature Language="F#" Value="new Microsoft.Identity.Client.AuthenticationResultMetadata : Microsoft.Identity.Client.TokenSource -> Microsoft.Identity.Client.AuthenticationResultMetadata" Usage="new Microsoft.Identity.Client.AuthenticationResultMetadata tokenSource" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="tokenSource" Type="Microsoft.Identity.Client.TokenSource" />
</Parameters>
<Docs>
<param name="tokenSource">To be added.</param>
<summary>
Constructor for the class AuthenticationResultMetadata
<param name="tokenSource">The token source.</param></summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CacheLevel">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.Cache.CacheLevel CacheLevel { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Identity.Client.Cache.CacheLevel CacheLevel" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.CacheLevel" />
<MemberSignature Language="VB.NET" Value="Public Property CacheLevel As CacheLevel" />
<MemberSignature Language="F#" Value="member this.CacheLevel : Microsoft.Identity.Client.Cache.CacheLevel with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.CacheLevel" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.Cache.CacheLevel</ReturnType>
</ReturnValue>
<Docs>
<summary>
Indicates the type of cache that the token was read from.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="CacheRefreshReason">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.CacheRefreshReason CacheRefreshReason { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Identity.Client.CacheRefreshReason CacheRefreshReason" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.CacheRefreshReason" />
<MemberSignature Language="VB.NET" Value="Public Property CacheRefreshReason As CacheRefreshReason" />
<MemberSignature Language="F#" Value="member this.CacheRefreshReason : Microsoft.Identity.Client.CacheRefreshReason with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.CacheRefreshReason" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.CacheRefreshReason</ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the reason for fetching the access token from the identity provider.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DurationInCacheInMs">
<MemberSignature Language="C#" Value="public long DurationInCacheInMs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 DurationInCacheInMs" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs" />
<MemberSignature Language="VB.NET" Value="Public Property DurationInCacheInMs As Long" />
<MemberSignature Language="F#" Value="member this.DurationInCacheInMs : int64 with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Time, in milliseconds, MSAL spent during this request reading and writing to the token cache, i.e. in the OnBeforeAccess, OnAfterAccess, etc. callbacks.
Does not include internal MSAL logic for searching through the cache once loaded.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DurationInHttpInMs">
<MemberSignature Language="C#" Value="public long DurationInHttpInMs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 DurationInHttpInMs" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs" />
<MemberSignature Language="VB.NET" Value="Public Property DurationInHttpInMs As Long" />
<MemberSignature Language="F#" Value="member this.DurationInHttpInMs : int64 with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Time, in milliseconds, MSAL spent for HTTP communication during this request.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DurationTotalInMs">
<MemberSignature Language="C#" Value="public long DurationTotalInMs { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 DurationTotalInMs" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs" />
<MemberSignature Language="VB.NET" Value="Public Property DurationTotalInMs As Long" />
<MemberSignature Language="F#" Value="member this.DurationTotalInMs : int64 with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.DurationTotalInMs" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>
Time, in milliseconds, spent to service this request. Includes time spent making HTTP requests <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInHttpInMs" />, time spent
in token cache callbacks <see cref="P:Microsoft.Identity.Client.AuthenticationResultMetadata.DurationInCacheInMs" />, time spent in MSAL and context switching.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RefreshOn">
<MemberSignature Language="C#" Value="public DateTimeOffset? RefreshOn { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype System.Nullable`1<valuetype System.DateTimeOffset> RefreshOn" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.RefreshOn" />
<MemberSignature Language="VB.NET" Value="Public Property RefreshOn As Nullable(Of DateTimeOffset)" />
<MemberSignature Language="F#" Value="member this.RefreshOn : Nullable<DateTimeOffset> with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.RefreshOn" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Nullable<System.DateTimeOffset></ReturnType>
</ReturnValue>
<Docs>
<summary>
Specifies the time when the cached token should be proactively refreshed.
This value may be null if proactive refresh is not enabled.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="RegionDetails">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.RegionDetails RegionDetails { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Microsoft.Identity.Client.RegionDetails RegionDetails" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.RegionDetails" />
<MemberSignature Language="VB.NET" Value="Public Property RegionDetails As RegionDetails" />
<MemberSignature Language="F#" Value="member this.RegionDetails : Microsoft.Identity.Client.RegionDetails with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.RegionDetails" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.RegionDetails</ReturnType>
</ReturnValue>
<Docs>
<summary>
Contains the outcome of the region discovery if region was used.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Telemetry">
<MemberSignature Language="C#" Value="public string Telemetry { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Telemetry" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.Telemetry" />
<MemberSignature Language="VB.NET" Value="Public Property Telemetry As String" />
<MemberSignature Language="F#" Value="member this.Telemetry : string with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.Telemetry" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
May contain telemetry data.
</summary>
<value>To be added.</value>
<remarks>
Currently it is emitted only for desktop public client flows when the broker is used and it is
also included in the verbose logs. May contain Personal Identifiable Information (PII), as per the logging settings.
See https://aka.ms/msal-net-logging for more details about logging.
</remarks>
</Docs>
</Member>
<Member MemberName="TokenEndpoint">
<MemberSignature Language="C#" Value="public string TokenEndpoint { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string TokenEndpoint" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenEndpoint" />
<MemberSignature Language="VB.NET" Value="Public Property TokenEndpoint As String" />
<MemberSignature Language="F#" Value="member this.TokenEndpoint : string with get, set" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.TokenEndpoint" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
The token endpoint used to contact the Identity Provider (e.g. Azure Active Directory).
Can be null, for example when the token comes from the cache.
</summary>
<value>To be added.</value>
<remarks>
This may be different from the endpoint you'd infer from the authority configured in the application object:
- if regional auth is used.
- if AAD instructs MSAL to use a different environment.
- if the authority or tenant is overridden at the request level.
- during a refresh_token operation, when MSAL must resolve "common" and "organizations" to a tenant ID.
</remarks>
</Docs>
</Member>
<Member MemberName="TokenSource">
<MemberSignature Language="C#" Value="public Microsoft.Identity.Client.TokenSource TokenSource { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Microsoft.Identity.Client.TokenSource TokenSource" />
<MemberSignature Language="DocId" Value="P:Microsoft.Identity.Client.AuthenticationResultMetadata.TokenSource" />
<MemberSignature Language="VB.NET" Value="Public ReadOnly Property TokenSource As TokenSource" />
<MemberSignature Language="F#" Value="member this.TokenSource : Microsoft.Identity.Client.TokenSource" Usage="Microsoft.Identity.Client.AuthenticationResultMetadata.TokenSource" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Identity.Client</AssemblyName>
<AssemblyVersion>4.60.3.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.Identity.Client.TokenSource</ReturnType>
</ReturnValue>
<Docs>
<summary>
The source of the token in the result.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>