OnlineIdAuthenticator.AuthenticateUserAsync OnlineIdAuthenticator.AuthenticateUserAsync OnlineIdAuthenticator.AuthenticateUserAsync OnlineIdAuthenticator.AuthenticateUserAsync OnlineIdAuthenticator.AuthenticateUserAsync Method

Definition

Overloads

AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) 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) AuthenticateUserAsync(OnlineIdServiceTicketRequest) AuthenticateUserAsync(OnlineIdServiceTicketRequest) AuthenticateUserAsync(OnlineIdServiceTicketRequest) 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) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest>, CredentialPromptType) 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 : UserAuthenticationOperation AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest> requests, CredentialPromptType credentialPromptType)
UserAuthenticationOperation AuthenticateUserAsync(IIterable<OnlineIdServiceTicketRequest> requests, CredentialPromptType credentialPromptType) const;
public UserAuthenticationOperation AuthenticateUserAsync(IEnumerable<OnlineIdServiceTicketRequest> requests, CredentialPromptType credentialPromptType)
Public Function AuthenticateUserAsync(requests As IEnumerable(Of OnlineIdServiceTicketRequest), credentialPromptType As CredentialPromptType) As UserAuthenticationOperation
Windows.Security.Authentication.OnlineId.OnlineIdAuthenticator.authenticateUserAsync(requests, credentialPromptType).done( /* Your success and error handlers */ );

Parameters

requests
IEnumerable<OnlineIdServiceTicketRequest> IEnumerable<OnlineIdServiceTicketRequest> IEnumerable<OnlineIdServiceTicketRequest>

A collection of requests.

credentialPromptType
CredentialPromptType CredentialPromptType CredentialPromptType

The type of credentials.

Returns

An object representing the authentication operation.

See also

AuthenticateUserAsync(OnlineIdServiceTicketRequest) AuthenticateUserAsync(OnlineIdServiceTicketRequest) AuthenticateUserAsync(OnlineIdServiceTicketRequest) AuthenticateUserAsync(OnlineIdServiceTicketRequest) 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 : UserAuthenticationOperation AuthenticateUserAsync(OnlineIdServiceTicketRequest request)
UserAuthenticationOperation AuthenticateUserAsync(OnlineIdServiceTicketRequest request) const;
public UserAuthenticationOperation AuthenticateUserAsync(OnlineIdServiceTicketRequest request)
Public Function AuthenticateUserAsync(request As OnlineIdServiceTicketRequest) As UserAuthenticationOperation
Windows.Security.Authentication.OnlineId.OnlineIdAuthenticator.authenticateUserAsync(request).done( /* Your success and error handlers */ );

Parameters

request
OnlineIdServiceTicketRequest OnlineIdServiceTicketRequest 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.

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