Skip to main content
OnlineIdAuthenticator.CanSignOut | canSignOut property

Indicates whether a user can sign out of the app, and whether to show the sign out link in the app.

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.


var canSignOut = onlineIdAuthenticator.canSignOut;

public bool CanSignOut { get; }

Public ReadOnly Property CanSignOut As Boolean

property bool CanSignOut { 
   bool get();

Property value

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

True if the user can sign out and the sign out link should be shown in the app, otherwise false.


An app that uses the OnlineIdAuthenticator class must show an option for the user to sign out. The sign out option must appear in the Settings charm, and the app must create a new page for its user account settings in Accounts. To see an example of how to add the sign out option and the account setting page, see the Windows Account Authorization sample.

If the user has a connected account, they can sign out by visiting the Users page in PC Settings.

If this property is false, a call to SignOutUserAsync fails with the ONL_E_CONNECTED_ACCOUNT_CAN_NOT_SIGNOUT error code.


var canSignOut = onlineIdAuthenticator.canSignOut;

if (Boolean(canSignOut)){

   // Add a "sign out" link to Charm settings.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0


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



Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

Minimum supported phone

Windows Phone 8


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



See also

Windows Account Authorization sample