OnlineIdAuthenticator.AuthenticateUserAsync Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| AuthenticateUserAsync(OnlineIdServiceTicketRequest) |
Starts the asynchronous authentication request with one OnlineIdServiceTicketRequest by showing the credential prompt if needed to collect credentials or consent and get the ticket. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request. Note If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager. |
| AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) |
Starts the async authentication request with multiple OnlineIdServiceTicketRequests and provides the ability to control the user experience by setting the CredentialPromptType to get the tickets. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request. Note If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager. |
AuthenticateUserAsync(OnlineIdServiceTicketRequest)
Starts the asynchronous authentication request with one OnlineIdServiceTicketRequest by showing the credential prompt if needed to collect credentials or consent and get the ticket. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request.
Note
If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.
public:
virtual UserAuthenticationOperation ^ AuthenticateUserAsync(OnlineIdServiceTicketRequest ^ request) = AuthenticateUserAsync;/// [Windows.Foundation.Metadata.Overload("AuthenticateUserAsync")]
UserAuthenticationOperation AuthenticateUserAsync(OnlineIdServiceTicketRequest const& request);[Windows.Foundation.Metadata.Overload("AuthenticateUserAsync")]
public UserAuthenticationOperation AuthenticateUserAsync(OnlineIdServiceTicketRequest request);function authenticateUserAsync(request)Public Function AuthenticateUserAsync (request As OnlineIdServiceTicketRequest) As UserAuthenticationOperationParameters
- request
- OnlineIdServiceTicketRequest
A request object that provides the ability for an app to specify the service and policy used to authenticate a Live user to obtain identity properties and tickets.
Returns
An object representing the authentication operation.
- Attributes
Remarks
When using these methods, consider the following error-handling guidelines:
- If the asynchronous authentication request fails, the error is captured in the errorcode of the IAsyncInfo object.
- If the asynchronous authentication requests starts and some of the tickets were obtained but some of them failed, the response is S_OK.
- If the authentication request itself succeeded but individual tickets couldn’t be requested, IAsyncInfo returns S_OK but OnlineIdServiceTicket.ErrorCode captures individual ticket error codes.
- If all of the ticket requests failed, the IAsyncInfo will contain the actual error code.
- If all calls succeeded and all of the tickets were successfully obtained, the error code will be S_OK indicating no error occurred .
See also
Applies to
AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType)
Starts the async authentication request with multiple OnlineIdServiceTicketRequests and provides the ability to control the user experience by setting the CredentialPromptType to get the tickets. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request.
Note
If you are developing for Windows 10 or greater, use the Windows.Security.Authentication.Web.Core APIs instead. For more information, see Web account manager.
public:
virtual UserAuthenticationOperation ^ AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest ^> ^ requests, CredentialPromptType credentialPromptType) = AuthenticateUserAsync;/// [Windows.Foundation.Metadata.Overload("AuthenticateUserAsyncAdvanced")]
UserAuthenticationOperation AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest> const& requests, CredentialPromptType const& credentialPromptType);[Windows.Foundation.Metadata.Overload("AuthenticateUserAsyncAdvanced")]
public UserAuthenticationOperation AuthenticateUserAsync(IEnumerable<OnlineIdServiceTicketRequest> requests, CredentialPromptType credentialPromptType);function authenticateUserAsync(requests, credentialPromptType)Public Function AuthenticateUserAsync (requests As IEnumerable(Of OnlineIdServiceTicketRequest), credentialPromptType As CredentialPromptType) As UserAuthenticationOperationParameters
A collection of requests.
- credentialPromptType
- CredentialPromptType
The type of credentials.
Returns
An object representing the authentication operation.
- Attributes
See also
Applies to
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for