4 <name>Microsoft.IdentityModel.Clients.ActiveDirectory</name>
7 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException">
9 The exception type thrown when an error occurs during token acquisition.
12 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.#ctor">
14 Initializes a new instance of the exception class.
17 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.#ctor(System.String)">
19 Initializes a new instance of the exception class with a specified
22 <param name="errorCode">The error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
24 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.#ctor(System.String,System.String)">
26 Initializes a new instance of the exception class with a specified
27 error code and error message.
29 <param name="errorCode">The error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
30 <param name="message">The error message that explains the reason for the exception.</param>
32 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.#ctor(System.String,System.Exception)">
34 Initializes a new instance of the exception class with a specified
35 error code and a reference to the inner exception that is the cause of
38 <param name="errorCode">The error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
39 <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified. It may especially contain the actual error message returned by the service.</param>
41 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.#ctor(System.String,System.String,System.Exception)">
43 Initializes a new instance of the exception class with a specified
44 error code, error message and a reference to the inner exception that is the cause of
47 <param name="errorCode">The error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
48 <param name="message">The error message that explains the reason for the exception.</param>
49 <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified. It may especially contain the actual error message returned by the service.</param>
51 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.ErrorCode">
53 Gets the protocol error code returned by the service or generated by client. This is the code you can rely on for exception handling.
56 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalException.ToString">
58 Creates and returns a string representation of the current exception.
60 <returns>A string representation of the current exception.</returns>
62 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.IWebProxyProvider.GetDefaultWebProxy">
64 Get the default <see cref="T:System.Net.IWebProxy"/>.
66 <returns>Default <see cref="T:System.Net.IWebProxy"/></returns>
68 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdParameter.Product">
70 ADAL Flavor: .NET or WinRT
73 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdParameter.Version">
78 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdParameter.CpuPlatform">
80 CPU platform with x86, x64 or ARM as value
83 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdParameter.OS">
85 Version of the operating system. This will not be sent on WinRT
88 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdParameter.DeviceModel">
90 Device model. This will not be sent on .NET
93 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalIdHelper">
95 This class adds additional query parameters or headers to the requests sent to STS. This can help us in
96 collecting statistics and potentially on diagnostics.
99 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException">
101 The exception type thrown when user returned by service does not match user in the request.
104 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.#ctor(System.String,System.String)">
106 Initializes a new instance of the exception class with a specified
107 error code and error message.
109 <param name="errorCode">The protocol error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
110 <param name="message">The error message that explains the reason for the exception.</param>
112 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.#ctor(System.String,System.Exception)">
114 Initializes a new instance of the exception class with a specified
115 error code and a reference to the inner exception that is the cause of
118 <param name="errorCode">The protocol error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
119 <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified. It may especially contain the actual error message returned by the service.</param>
121 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.#ctor(System.String,System.String,System.String[],System.Exception)">
123 Initializes a new instance of the exception class with a specified
124 error code, error message and a reference to the inner exception that is the cause of
127 <param name="errorCode">The protocol error code returned by the service or generated by client. This is the code you can rely on for exception handling.</param>
128 <param name="message">The error message that explains the reason for the exception.</param>
129 <param name="serviceErrorCodes">The specific error codes that may be returned by the service.</param>
130 <param name="innerException">The exception that is the cause of the current exception, or a null reference if no inner exception is specified. It may especially contain the actual error message returned by the service.</param>
132 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.StatusCode">
134 Gets the status code returned from http layer. This status code is either the HttpStatusCode in the inner HttpRequestException response or
135 NavigateError Event Status Code in browser based flow (See http://msdn.microsoft.com/en-us/library/bb268233(v=vs.85).aspx).
136 You can use this code for purposes such as implementing retry logic or error investigation.
139 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.ServiceErrorCodes">
141 Gets the specific error codes that may be returned by the service.
144 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalServiceException.ToString">
146 Creates and returns a string representation of the current exception.
148 <returns>A string representation of the current exception.</returns>
150 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalSilentTokenAcquisitionException">
152 The exception type thrown when a token cannot be acquired silently.
155 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalSilentTokenAcquisitionException.#ctor">
157 Initializes a new instance of the exception class.
160 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalSilentTokenAcquisitionException.#ctor(System.Exception)">
164 <param name="innerException"></param>
166 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalUserMismatchException">
168 The exception type thrown when user returned by service does not match user in the request.
171 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalUserMismatchException.#ctor(System.String,System.String)">
173 Initializes a new instance of the exception class.
176 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalUserMismatchException.RequestedUser">
178 Gets the user requested from service.
181 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalUserMismatchException.ReturnedUser">
183 Gets the user returned by service.
186 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalUserMismatchException.ToString">
188 Creates and returns a string representation of the current exception.
190 <returns>A string representation of the current exception.</returns>
192 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext">
194 The AuthenticationContext class retrieves authentication tokens from Azure Active Directory and ADFS services.
197 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.#ctor(System.String)">
199 Constructor to create the context with the address of the authority.
200 Using this constructor will turn ON validation of the authority URL by default if validation is supported for the authority address.
202 <param name="authority">Address of the authority to issue token.</param>
204 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.#ctor(System.String,System.Boolean)">
206 Constructor to create the context with the address of the authority and flag to turn address validation off.
207 Using this constructor, address validation can be turned off. Make sure you are aware of the security implication of not validating the address.
209 <param name="authority">Address of the authority to issue token.</param>
210 <param name="validateAuthority">Flag to turn address validation ON or OFF.</param>
212 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.#ctor(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache)">
214 Constructor to create the context with the address of the authority.
215 Using this constructor will turn ON validation of the authority URL by default if validation is supported for the authority address.
217 <param name="authority">Address of the authority to issue token.</param>
218 <param name="tokenCache">Token cache used to lookup cached tokens on calls to AcquireToken</param>
220 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.#ctor(System.String,System.Boolean,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache)">
222 Constructor to create the context with the address of the authority and flag to turn address validation off.
223 Using this constructor, address validation can be turned off. Make sure you are aware of the security implication of not validating the address.
225 <param name="authority">Address of the authority to issue token.</param>
226 <param name="validateAuthority">Flag to turn address validation ON or OFF.</param>
227 <param name="tokenCache">Token cache used to lookup cached tokens on calls to AcquireToken</param>
229 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.ExtendedLifeTimeEnabled">
231 Used to set the flag for AAD extended lifetime
234 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.Authority">
236 Gets address of the authority to issue token.
239 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.ValidateAuthority">
241 Gets a value indicating whether address validation is ON or OFF.
244 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.TokenCache">
246 Property to provide ADAL's token cache. Depending on the platform, TokenCache may have a default persistent cache or not.
247 Library will automatically save tokens in default TokenCache whenever you obtain them. Cached tokens will be available only to the application that saved them.
248 If the cache is persistent, the tokens stored in it will outlive the application's execution, and will be available in subsequent runs.
249 To turn OFF token caching, set TokenCache to null.
252 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.CorrelationId">
254 Gets or sets correlation Id which would be sent to the service with the next request.
255 Correlation Id is to be used for diagnostics purposes.
258 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireDeviceCodeAsync(System.String,System.String)">
260 Acquires device code from the authority.
262 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
263 <param name="clientId">Identifier of the client requesting the token.</param>
264 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
266 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireDeviceCodeAsync(System.String,System.String,System.String)">
268 Acquires device code from the authority.
270 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
271 <param name="clientId">Identifier of the client requesting the token.</param>
272 <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param>
273 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
275 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByDeviceCodeAsync(Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult)">
277 Acquires security token from the authority using an device code previously received.
278 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
280 <param name="deviceCodeResult">The device code result received from calling AcquireDeviceCodeAsync.</param>
281 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
283 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion)">
285 Acquires security token from the authority.
287 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
288 <param name="clientId">Identifier of the client requesting the token.</param>
289 <param name="userAssertion">The assertion to use for token acquisition.</param>
290 <returns>It contains Access Token and the Access Token's expiration time. Refresh Token property will be null for this overload.</returns>
292 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential)">
294 Acquires security token from the authority.
296 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
297 <param name="clientCredential">The client credential to use for token acquisition.</param>
298 <returns>It contains Access Token and the Access Token's expiration time. Refresh Token property will be null for this overload.</returns>
300 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate)">
302 Acquires security token from the authority.
304 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
305 <param name="clientCertificate">The client certificate to use for token acquisition.</param>
306 <returns>It contains Access Token and the Access Token's expiration time. Refresh Token property will be null for this overload.</returns>
308 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion)">
310 Acquires security token from the authority.
312 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
313 <param name="clientAssertion">The client assertion to use for token acquisition.</param>
314 <returns>It contains Access Token and the Access Token's expiration time. Refresh Token property will be null for this overload.</returns>
316 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential)">
318 Acquires security token from the authority using authorization code previously received.
319 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
321 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
322 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
323 <param name="clientCredential">The credential to use for token acquisition.</param>
324 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
326 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential,System.String)">
328 Acquires security token from the authority using an authorization code previously received.
329 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
331 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
332 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
333 <param name="clientCredential">The credential to use for token acquisition.</param>
334 <param name="resource">Identifier of the target resource that is the recipient of the requested token. It can be null if provided earlier to acquire authorizationCode.</param>
335 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
337 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion)">
339 Acquires security token from the authority using an authorization code previously received.
340 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
342 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
343 <param name="redirectUri">The redirect address used for obtaining authorization code.</param>
344 <param name="clientAssertion">The client assertion to use for token acquisition.</param>
345 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
347 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion,System.String)">
349 Acquires security token from the authority using an authorization code previously received.
350 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
352 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
353 <param name="redirectUri">The redirect address used for obtaining authorization code.</param>
354 <param name="clientAssertion">The client assertion to use for token acquisition.</param>
355 <param name="resource">Identifier of the target resource that is the recipient of the requested token. It can be null if provided earlier to acquire authorizationCode.</param>
356 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
358 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate)">
360 Acquires security token from the authority using an authorization code previously received.
361 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
363 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
364 <param name="redirectUri">The redirect address used for obtaining authorization code.</param>
365 <param name="clientCertificate">The client certificate to use for token acquisition.</param>
366 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
368 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenByAuthorizationCodeAsync(System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate,System.String)">
370 Acquires security token from the authority using an authorization code previously received.
371 This method does not lookup token cache, but stores the result in it, so it can be looked up using other methods such as <see cref="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)"/>.
373 <param name="authorizationCode">The authorization code received from service authorization endpoint.</param>
374 <param name="redirectUri">The redirect address used for obtaining authorization code.</param>
375 <param name="clientCertificate">The client certificate to use for token acquisition.</param>
376 <param name="resource">Identifier of the target resource that is the recipient of the requested token. It can be null if provided earlier to acquire authorizationCode.</param>
377 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
379 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential,Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion)">
381 Acquires an access token from the authority on behalf of a user. It requires using a user token previously received.
383 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
384 <param name="clientCredential">The client credential to use for token acquisition.</param>
385 <param name="userAssertion">The user assertion (token) to use for token acquisition.</param>
386 <returns>It contains Access Token and the Access Token's expiration time.</returns>
388 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate,Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion)">
390 Acquires an access token from the authority on behalf of a user. It requires using a user token previously received.
392 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
393 <param name="clientCertificate">The client certificate to use for token acquisition.</param>
394 <param name="userAssertion">The user assertion (token) to use for token acquisition.</param>
395 <returns>It contains Access Token and the Access Token's expiration time.</returns>
397 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion,Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion)">
399 Acquires an access token from the authority on behalf of a user. It requires using a user token previously received.
401 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
402 <param name="clientAssertion">The client assertion to use for token acquisition.</param>
403 <param name="userAssertion">The user assertion (token) to use for token acquisition.</param>
404 <returns>It contains Access Token and the Access Token's expiration time.</returns>
406 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String)">
408 Acquires security token without asking for user credential.
410 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
411 <param name="clientId">Identifier of the client requesting the token.</param>
412 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
414 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)">
416 Acquires security token without asking for user credential.
418 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
419 <param name="clientId">Identifier of the client requesting the token.</param>
420 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
421 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
423 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier,Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters)">
425 Acquires security token without asking for user credential.
427 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
428 <param name="clientId">Identifier of the client requesting the token.</param>
429 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
430 <param name="parameters">Instance of PlatformParameters containing platform specific arguments and information.</param>
431 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
433 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)">
435 Acquires security token without asking for user credential.
437 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
438 <param name="clientCredential">The client credential to use for token acquisition.</param>
439 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
440 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
442 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)">
444 Acquires security token without asking for user credential.
446 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
447 <param name="clientCertificate">The client certificate to use for token acquisition.</param>
448 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
449 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
451 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenSilentAsync(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)">
453 Acquires security token without asking for user credential.
455 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
456 <param name="clientAssertion">The client assertion to use for token acquisition.</param>
457 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
458 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time. If acquiring token without user credential is not possible, the method throws AdalException.</returns>
460 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.GetAuthorizationRequestUrlAsync(System.String,System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier,System.String)">
462 Gets URL of the authorize endpoint including the query parameters.
464 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
465 <param name="clientId">Identifier of the client requesting the token.</param>
466 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
467 <param name="userId">Identifier of the user token is requested for. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
468 <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param>
469 <returns>URL of the authorize endpoint including the query parameters.</returns>
471 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters)">
473 Acquires security token from the authority.
475 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
476 <param name="clientId">Identifier of the client requesting the token.</param>
477 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
478 <param name="parameters">An object of type PlatformParameters which may pass additional parameters used for authorization.</param>
479 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
481 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier)">
483 Acquires security token from the authority.
485 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
486 <param name="clientId">Identifier of the client requesting the token.</param>
487 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
488 <param name="parameters">An object of type PlatformParameters which may pass additional parameters used for authorization.</param>
489 <param name="userId">Identifier of the user token is requested for. If created from DisplayableId, this parameter will be used to pre-populate the username field in the authentication form. Please note that the end user can still edit the username field and authenticate as a different user.
490 If you want to be notified of such change with an exception, create UserIdentifier with type RequiredDisplayableId. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
491 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
493 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext.AcquireTokenAsync(System.String,System.String,System.Uri,Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier,System.String)">
495 Acquires security token from the authority.
497 <param name="resource">Identifier of the target resource that is the recipient of the requested token.</param>
498 <param name="clientId">Identifier of the client requesting the token.</param>
499 <param name="redirectUri">Address to return to upon receiving a response from the authority.</param>
500 <param name="userId">Identifier of the user token is requested for. If created from DisplayableId, this parameter will be used to pre-populate the username field in the authentication form. Please note that the end user can still edit the username field and authenticate as a different user.
501 If you want to be notified of such change with an exception, create UserIdentifier with type RequiredDisplayableId. This parameter can be <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.Any.</param>
502 <param name="parameters">Parameters needed for interactive flow requesting authorization code. Pass an instance of PlatformParameters.</param>
503 <param name="extraQueryParameters">This parameter will be appended as is to the query string in the HTTP authentication request to the authority. The parameter can be null.</param>
504 <returns>It contains Access Token, Refresh Token and the Access Token's expiration time.</returns>
506 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters">
508 Contains authentication parameters based on unauthorized response from resource server.
511 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.Authority">
513 Gets or sets the address of the authority to issue token.
516 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.Resource">
518 Gets or sets the identifier of the target resource that is the recipient of the requested token.
521 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.CreateFromResourceUrlAsync(System.Uri)">
523 Creates authentication parameters from address of the resource. This method expects the resource server to return unauthorized response
524 with WWW-Authenticate header containing authentication parameters.
526 <param name="resourceUrl">Address of the resource</param>
527 <returns>AuthenticationParameters object containing authentication parameters</returns>
529 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.CreateFromUnauthorizedResponseAsync(System.Net.Http.HttpResponseMessage)">
531 Creates authentication parameters from the response received from the response received from the resource. This method expects the response to have unauthorized status and
532 WWW-Authenticate header containing authentication parameters.</summary>
533 <param name="responseMessage">Response received from the resource (e.g. via an http call using HttpClient).</param>
534 <returns>AuthenticationParameters object containing authentication parameters</returns>
536 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationParameters.CreateFromResponseAuthenticateHeader(System.String)">
538 Creates authentication parameters from the WWW-Authenticate header in response received from resource. This method expects the header to contain authentication parameters.
540 <param name="authenticateHeader">Content of header WWW-Authenticate header</param>
541 <returns>AuthenticationParameters object containing authentication parameters</returns>
543 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult">
545 Contains the results of one token acquisition operation.
548 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.#ctor(System.String,System.String,System.DateTimeOffset)">
550 Creates result returned from AcquireToken. Except in advanced scenarios related to token caching, you do not need to create any instance of AuthenticationResult.
552 <param name="accessTokenType">Type of the Access Token returned</param>
553 <param name="accessToken">The Access Token requested</param>
554 <param name="expiresOn">The point in time in which the Access Token returned in the AccessToken property ceases to be valid</param>
556 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.#ctor(System.String,System.String,System.DateTimeOffset,System.DateTimeOffset)">
558 Creates result returned from AcquireToken. Except in advanced scenarios related to token caching, you do not need to create any instance of AuthenticationResult.
560 <param name="accessTokenType">Type of the Access Token returned</param>
561 <param name="accessToken">The Access Token requested</param>
562 <param name="expiresOn">The point in time in which the Access Token returned in the AccessToken property ceases to be valid</param>
563 <param name="extendedExpiresOn">The point in time in which the Access Token returned in the AccessToken property ceases to be valid</param>
565 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.AccessTokenType">
567 Gets the type of the Access Token returned.
570 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.AccessToken">
572 Gets the Access Token requested.
575 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.ExpiresOn">
577 Gets the point in time in which the Access Token returned in the AccessToken property ceases to be valid.
578 This value is calculated based on current UTC time measured locally and the value expiresIn received from the service.
581 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.ExtendedExpiresOn">
583 Gets the point in time in which the Access Token returned in the AccessToken property ceases to be valid in ADAL's extended LifeTime.
584 This value is calculated based on current UTC time measured locally and the value ext_expiresIn received from the service.
587 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.ExtendedLifeTimeToken">
589 Gives information to the developer whether token returned is during normal or extended lifetime.
592 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.TenantId">
594 Gets an identifier for the tenant the token was acquired from. This property will be null if tenant information is not returned by the service.
597 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.UserInfo">
599 Gets user information including user Id. Some elements in UserInfo might be null if not returned by the service.
602 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.IdToken">
604 Gets the entire Id Token if returned by the service or null if no Id Token is returned.
607 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult.CreateAuthorizationHeader">
609 Creates authorization header from authentication result.
611 <returns>Created authorization header</returns>
613 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.ISecureClientSecret">
615 Interface to allow for client secret to be passed in as a SecureString
618 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.ISecureClientSecret.ApplyTo(System.Collections.Generic.IDictionary{System.String,System.String})">
620 Writes SecureString to the dictionary.
622 <param name="parameters"></param>
624 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion">
626 Credential type containing an assertion of type "urn:ietf:params:oauth:token-type:jwt".
629 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion.#ctor(System.String,System.String)">
631 Constructor to create credential with a jwt token encoded as a base64 url encoded string.
633 <param name="clientId">Identifier of the client requesting the token.</param>
634 <param name="assertion">The jwt used as credential.</param>
636 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion.ClientId">
638 Gets the identifier of the client requesting the token.
641 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion.Assertion">
646 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientAssertion.AssertionType">
648 Gets the assertion type.
651 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential">
653 Credential including client id and secret.
656 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential.#ctor(System.String,System.String)">
658 Constructor to create credential with client id and secret
660 <param name="clientId">Identifier of the client requesting the token.</param>
661 <param name="clientSecret">Secret of the client requesting the token.</param>
663 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential.#ctor(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.ISecureClientSecret)">
665 Constructor to create credential with client id and secret
667 <param name="clientId">Identifier of the client requesting the token.</param>
668 <param name="secureClientSecret">Secure secret of the client requesting the token.</param>
670 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.ClientCredential.ClientId">
672 Gets the identifier of the client requesting the token.
675 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError">
677 Error code returned as a property in AdalException
680 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.Unknown">
685 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.NonHttpsRedirectNotSupported">
687 Non https redirect failed
690 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.InvalidArgument">
695 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AuthenticationFailed">
697 Authentication failed.
700 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AuthenticationCanceled">
702 Authentication canceled.
705 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UnauthorizedResponseExpected">
707 Unauthorized response expected from resource server.
710 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AuthorityNotInValidList">
712 'authority' is not in the list of valid addresses.
715 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AuthorityValidationFailed">
717 Authority validation failed.
720 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AssemblyLoadFailed">
722 Loading required assembly failed.
725 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AssemblyNotFound">
730 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.InvalidOwnerWindowType">
732 Invalid owner window type.
735 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.MultipleTokensMatched">
737 MultipleTokensMatched were matched.
740 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.InvalidAuthorityType">
742 Invalid authority type.
745 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.InvalidCredentialType">
747 Invalid credential type.
750 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.InvalidServiceUrl">
755 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.FailedToAcquireTokenSilently">
757 failed_to_acquire_token_silently.
760 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.CertificateKeySizeTooSmall">
762 Certificate key size too small.
765 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.IdentityProtocolLoginUrlNull">
767 Identity protocol login URL Null.
770 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.IdentityProtocolMismatch">
772 Identity protocol mismatch.
775 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.EmailAddressSuffixMismatch">
777 Email address suffix mismatch.
780 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.IdentityProviderRequestFailed">
782 Identity provider request failed.
785 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.StsTokenRequestFailed">
787 STS token request failed.
790 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.EncodedTokenTooLong">
792 Encoded token too long.
795 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.ServiceUnavailable">
800 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.ServiceReturnedError">
802 Service returned error.
805 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.FederatedServiceReturnedError">
807 Federated service returned error.
810 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.StsMetadataRequestFailed">
812 STS metadata request failed.
815 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.NoDataFromSts">
820 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UserMismatch">
825 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UnknownUserType">
830 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UnknownUser">
835 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UserRealmDiscoveryFailed">
837 User Realm Discovery Failed.
840 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AccessingWsMetadataExchangeFailed">
842 Accessing WS Metadata Exchange Failed.
845 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.ParsingWsMetadataExchangeFailed">
847 Parsing WS Metadata Exchange Failed.
850 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.WsTrustEndpointNotFoundInMetadataDocument">
852 WS-Trust Endpoint Not Found in Metadata Document.
855 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.ParsingWsTrustResponseFailed">
857 Parsing WS-Trust Response Failed.
860 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.NetworkNotAvailable">
862 The request could not be preformed because the network is down.
865 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.AuthenticationUiFailed">
867 The request could not be preformed because of an unknown failure in the UI flow.
870 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.UserInteractionRequired">
872 One of two conditions was encountered.
873 1. The PromptBehavior.Never flag was passed and but the constraint could not be honored
874 because user interaction was required.
875 2. An error occurred during a silent web authentication that prevented the authentication
876 flow from completing in a short enough time frame.
879 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.PasswordRequiredForManagedUserError">
881 Password is required for managed user.
884 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.GetUserNameFailed">
886 Failed to get user name.
889 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.MissingFederationMetadataUrl">
891 Federation Metadata Url is missing for federated user.
894 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.FailedToRefreshToken">
896 Failed to refresh token.
899 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.IntegratedAuthFailed">
901 Integrated authentication failed. You may try an alternative authentication method.
904 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.DuplicateQueryParameter">
906 Duplicate query parameter in extraQueryParameters
909 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.BrokerReponseHashMismatch">
911 Broker response hash did not match
914 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalError.DeviceCertificateNotFound">
916 Device certificate not found.
919 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AdalErrorMessage">
921 The active directory authentication error message.
924 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult">
926 This class represents the response from the service when requesting device code.
929 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.UserCode">
931 User code returned by the service
934 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.DeviceCode">
936 Device code returned by the service
939 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.VerificationUrl">
941 Verification URL where the user must navigate to authenticate using the device code and credentials.
944 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.ExpiresOn">
946 Time when the device code will expire.
949 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.Interval">
951 Polling interval time to check for completion of authentication flow.
954 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.Message">
956 User friendly text response that can be used for display purpose.
959 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.ClientId">
961 Identifier of the client requesting device code.
964 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.DeviceCodeResult.Resource">
966 Identifier of the target resource that would be the recipient of the token.
969 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel">
974 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel.Information">
976 Information log level
979 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel.Verbose">
984 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel.Warning">
989 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel.Error">
994 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.IAdalLogCallback">
996 Callback for capturing ADAL logs to custom logging schemes.
999 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.IAdalLogCallback.Log(Microsoft.IdentityModel.Clients.ActiveDirectory.LogLevel,System.String)">
1001 Callback method to implement for custom logging
1003 <param name="level">Log level</param>
1004 <param name="message">message to be logged</param>
1006 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.LoggerCallbackHandler">
1008 This class is responsible for managing the callback state and its execution.
1011 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.LoggerCallbackHandler.UseDefaultLogging">
1013 Flag to control whether default logging should be performed in addition to calling
1014 the <see cref="P:Microsoft.IdentityModel.Clients.ActiveDirectory.LoggerCallbackHandler.Callback"/> handler (if any)
1017 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.LoggerCallbackHandler.Callback">
1019 Callback implementation
1022 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate">
1024 Interface for implementing certificate based operations
1027 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate.Sign(System.String)">
1029 Signs a message using the private key in the certificate
1031 <param name="message">Message that needs to be signed</param>
1032 <returns>Signed message as a byte array</returns>
1034 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate.ClientId">
1036 Gets the identifier of the client requesting the token.
1039 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.IClientAssertionCertificate.Thumbprint">
1041 Thumbprint of the Certificate
1044 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.IPlatformParameters">
1046 Empty interface implemented in each supported platform.
1049 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResultEx.RefreshToken">
1051 Gets the Refresh Token associated with the requested Access Token. Note: not all operations will return a Refresh Token.
1054 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResultEx.IsMultipleResourceRefreshToken">
1056 Gets a value indicating whether the refresh token can be used for requesting access token for other resources.
1059 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResultEx.Deserialize(System.String)">
1061 Serializes the object to a JSON string
1063 <returns>Deserialized authentication result</returns>
1065 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResultEx.Serialize">
1067 Serializes the object to a JSON string
1069 <returns>Serialized authentication result</returns>
1071 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.EncodingHelper">
1073 The encoding helper.
1076 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache">
1078 Token cache class used by <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext"/> to store access and refresh tokens.
1081 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.TokenCacheNotification">
1083 Notification for certain token cache interactions during token acquisition.
1085 <param name="args">Arguments related to the cache item impacted</param>
1087 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.#ctor">
1089 Default constructor.
1092 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.#ctor(System.Byte[])">
1094 Constructor receiving state of the cache
1097 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.DefaultShared">
1099 Static token cache shared by all instances of AuthenticationContext which do not explicitly pass a cache instance during construction.
1102 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.BeforeAccess">
1104 Notification method called before any library method accesses the cache.
1107 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.BeforeWrite">
1109 Notification method called before any library method writes to the cache. This notification can be used to reload
1110 the cache state from a row in database and lock that row. That database row can then be unlocked in <see cref="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.AfterAccess"/> notification.
1113 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.AfterAccess">
1115 Notification method called after any library method accesses the cache.
1118 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.HasStateChanged">
1120 Gets or sets the flag indicating whether cache state has changed. ADAL methods set this flag after any change. Caller application should reset
1121 the flag after serializing and persisting the state of the cache.
1124 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.Count">
1126 Gets the nunmber of items in the cache.
1129 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.Serialize">
1131 Serializes current state of the cache as a blob. Caller application can persist the blob and update the state of the cache later by
1132 passing that blob back in constructor or by calling method Deserialize.
1134 <returns>Current state of the cache as a blob</returns>
1136 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.Deserialize(System.Byte[])">
1138 Deserializes state of the cache. The state should be the blob received earlier by calling the method Serialize.
1140 <param name="state">State of the cache as a blob</param>
1142 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.ReadItems">
1144 Reads a copy of the list of all items in the cache.
1146 <returns>The items in the cache</returns>
1148 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.DeleteItem(Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem)">
1150 Deletes an item from the cache.
1152 <param name="item">The item to delete from the cache</param>
1154 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.Clear">
1156 Clears the cache by deleting all the items. Note that if the cache is the default shared cache, clearing it would
1157 impact all the instances of <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationContext"/> which share that cache.
1160 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCache.QueryCache(System.String,System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.TokenSubjectType,System.String,System.String,System.String)">
1162 Queries all values in the cache that meet the passed in values, plus the
1163 authority value that this AuthorizationContext was created with. In every case passing
1164 null results in a wildcard evaluation.
1167 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem">
1172 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.#ctor(Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey,Microsoft.IdentityModel.Clients.ActiveDirectory.AuthenticationResult)">
1174 Default constructor.
1177 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.Authority">
1182 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.ClientId">
1187 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.ExpiresOn">
1189 Gets the Expiration.
1192 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.FamilyName">
1194 Gets the FamilyName.
1197 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.GivenName">
1202 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.IdentityProvider">
1204 Gets the IdentityProviderName.
1207 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.Resource">
1212 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.TenantId">
1217 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.UniqueId">
1219 Gets the user's unique Id.
1222 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.DisplayableId">
1224 Gets the user's displayable Id.
1227 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.AccessToken">
1229 Gets the Access Token requested.
1232 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheItem.IdToken">
1234 Gets the entire Id Token if returned by the service or null if no Id Token is returned.
1237 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenSubjectType">
1239 Determines what type of subject the token was issued for.
1242 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenSubjectType.User">
1247 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenSubjectType.Client">
1252 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenSubjectType.UserPlusClient">
1254 UserPlusClient: This is for confidential clients used in middle tier.
1257 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey">
1259 <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey"/> can be used with Linq to access items from the TokenCache dictionary.
1262 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey.Equals(System.Object)">
1264 Determines whether the specified object is equal to the current object.
1267 true if the specified object is equal to the current object; otherwise, false.
1269 <param name="obj">The object to compare with the current object. </param><filterpriority>2</filterpriority>
1271 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey.Equals(Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey)">
1273 Determines whether the specified TokenCacheKey is equal to the current object.
1276 true if the specified TokenCacheKey is equal to the current object; otherwise, false.
1278 <param name="other">The TokenCacheKey to compare with the current object. </param><filterpriority>2</filterpriority>
1280 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheKey.GetHashCode">
1282 Returns the hash code for this TokenCacheKey.
1285 A 32-bit signed integer hash code.
1288 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs">
1290 Contains parameters used by the ADAL call accessing the cache.
1293 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs.TokenCache">
1298 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs.ClientId">
1303 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs.Resource">
1308 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs.UniqueId">
1310 Gets the user's unique Id.
1313 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.TokenCacheNotificationArgs.DisplayableId">
1315 Gets the user's displayable Id.
1318 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion">
1320 Credential type containing an assertion representing user credential.
1323 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.#ctor(System.String)">
1325 Constructor to create the object with an assertion. This constructor can be used for On Behalf Of flow which assumes the
1326 assertion is a JWT token. For other flows, the other construction with assertionType must be used.
1328 <param name="assertion">Assertion representing the user.</param>
1330 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.#ctor(System.String,System.String)">
1332 Constructor to create credential with client id, assertion and assertionType
1334 <param name="assertion">Assertion representing the user.</param>
1335 <param name="assertionType">Type of the assertion representing the user.</param>
1337 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.#ctor(System.String,System.String,System.String)">
1339 Constructor to create credential with client id, assertion, assertionType and userId
1341 <param name="assertion">Assertion representing the user.</param>
1342 <param name="assertionType">Type of the assertion representing the user.</param>
1343 <param name="userName">Identity of the user token is requested for. This parameter can be null.</param>
1345 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.Assertion">
1350 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.AssertionType">
1352 Gets the assertion type.
1355 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserAssertion.UserName">
1357 Gets name of the user.
1360 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential">
1362 Credential used for integrated authentication on domain-joined machines.
1365 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential.#ctor">
1367 Constructor to create user credential. Using this constructor would imply integrated authentication with logged in user
1368 and it can only be used in domain joined scenarios.
1371 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential.#ctor(System.String)">
1373 Constructor to create credential with client id and secret
1375 <param name="userName">Identifier of the user application requests token on behalf.</param>
1377 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserCredential.UserName">
1379 Gets identifier of the user.
1382 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifierType">
1384 Indicates the type of <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>
1387 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifierType.UniqueId">
1389 When a <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/> of this type is passed in a token acquisition operation,
1390 the operation is guaranteed to return a token issued for the user with corresponding <see cref="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.UniqueId"/> or fail.
1393 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifierType.OptionalDisplayableId">
1395 When a <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/> of this type is passed in a token acquisition operation,
1396 the operation restricts cache matches to the value provided and injects it as a hint in the authentication experience. However the end user could overwrite that value, resulting in a token issued to a different account than the one specified in the <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/> in input.
1399 <member name="F:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifierType.RequiredDisplayableId">
1401 When a <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/> of this type is passed in a token acquisition operation,
1402 the operation is guaranteed to return a token issued for the user with corresponding <see cref="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.DisplayableId"/> (UPN or email) or fail
1405 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier">
1407 Contains identifier for a user.
1410 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.#ctor(System.String,Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifierType)">
1414 <param name="id"></param>
1415 <param name="type"></param>
1417 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.Type">
1419 Gets type of the <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.
1422 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.Id">
1424 Gets Id of the <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/>.
1427 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier.AnyUser">
1429 Gets an static instance of <see cref="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserIdentifier"/> to represent any user.
1432 <member name="T:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo">
1434 Contains information of a single user. This information is used for token cache lookup. Also if created with userId, userId is sent to the service when login_hint is accepted.
1437 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.#ctor">
1439 Create user information for token cache lookup
1442 <member name="M:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.#ctor(Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo)">
1444 Create user information copied from another UserInfo object
1447 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.UniqueId">
1449 Gets identifier of the user authenticated during token acquisition.
1452 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.DisplayableId">
1454 Gets a displayable value in UserPrincipalName (UPN) format. The value can be null.
1457 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.GivenName">
1459 Gets given name of the user if provided by the service. If not, the value is null.
1462 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.FamilyName">
1464 Gets family name of the user if provided by the service. If not, the value is null.
1467 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.PasswordExpiresOn">
1469 Gets the time when the password expires. Default value is 0.
1472 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.PasswordChangeUrl">
1474 Gets the url where the user can change the expiring password. The value can be null.
1477 <member name="P:Microsoft.IdentityModel.Clients.ActiveDirectory.UserInfo.IdentityProvider">
1479 Gets identity provider if returned by the service. If not, the value is null.