OnlineIdAuthenticator.AuthenticateUserAsync | authenticateUserAsync methods

Starts the async 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 system running Windows 8 system with a Microsoft account, then this user will be used for the authentication request.

Overload list

MethodDescription
AuthenticateUserAsync(OnlineIdServiceTicketRequest) Starts the async authentication request with one OnlineIdServiceTicketRequest. If a user is signed into a Windows 8 system with a Microsoft account, this user will be used for the authentication request.
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.

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 .

Windows Phone 8

This API is not implemented and will throw an exception if called. See Windows Phone Runtime API.

Requirements

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8 [not implemented, see Remarks]

Namespace

Windows.Security.Authentication.OnlineId
Windows::Security::Authentication::OnlineId [C++]

Metadata

Windows.winmd

See also

OnlineIdAuthenticator

 

 

Show:
© 2014 Microsoft