Windows Live oauth authenticator that can be used with any Java-based Web API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Type Name Latest commit message Commit time
Failed to load latest commit information.


Windows Live Authenticator Plug-in

This project provides an opens source Windows Live Authenticator plug-in for the Curity Identity Server. This allows an administrator to add functionality to Curity which will then enable end users to login using their Windows Live credentials. The app that integrates with Curity may also be configured to receive the Windows Live access token, allowing it to manage resources in Windows Live.

System Requirements

Requirements for Building from Source

  • Maven 3
  • Java JDK v. 8

Compiling the Plug-in from Source

The source is very easy to compile. To do so from a shell, issue this command: mvn package.


To install this plug-in, either download a binary version available from the releases section of this project's GitHub repository or compile it from source (as described above). If you compiled the plug-in from source, the package will be placed in the target subdirectory. The resulting JAR file or the one downloaded from GitHub needs to placed in the directory ${IDSVR_HOME}/usr/share/plugins/windows-live. (The name of the last directory, windows-live, which is the plug-in group, is arbitrary and can be anything.) After doing so, the plug-in will become available as soon as the node is restarted.


The JAR file needs to be deployed to each run-time node and the admin node. For simple test deployments where the admin node is a run-time node, the JAR file only needs to be copied to one location.

For a more detailed explanation of installing plug-ins, refer to the Curity developer guide.

Creating an App in Windows Live

As described in the Windows Live documentation, you can create apps that use the Windows Live APIs as shown in the following figure:


Then, give the app a name, e.g., Curity App.

After you click create, you will be able to see application configuration where you can find the Client ID (Application Id), to get Secret Key You need to Generate New Password. These settings will be needed later when configuring the plug-in in Curity.


To configure the Redirect URLs you need to Add Platform as show in following figure and select Web from give options.


Windows Live will display the Callback URLs in the new platform's configuration. This needs to match the yet-to-be-created Windows Live authenticator instance in Curity. The default will not work, and, if used, will result in an error. This should be updated to some URL that follows the pattern $baseUrl/$authenticationEndpointPath/$windowsLiveAuthnticatorId/callback, where each of these URI components has the following meaning:

URI Component Meaning
baseUrl The base URL of the server (defined on the System --> General page of the admin GUI). If this value is not set, then the server scheme, name, and port should be used (e.g., https://localhost:8443).
authenticationEndpointPath The path of the authentication endpoint. In the admin GUI, this is located in the authentication profile's Endpoints tab for the endpoint that has the type auth-authentication.
windowsLiveAuthenticatorId This is the name given to the Windows Live authenticator when defining it (e.g., windowsLive1).

Once the Callback URL is updated, the only thing left is to configure scopes. Click on Delegated Permissions Add button in order to configure scopes as shown in below figure:


It could be helpful to also enable additional scopes. Scopes are the Windows Live related rights or permissions that the app is requesting. If the final application (not Curity, but the downstream app) is going to perform actions using the Windows Live API, additional scopes probably should be enabled. Refer to the Windows Live documentation on scopes for an explanation of those that can be enabled and what they allow.


If the app configuration in Windows Live does not allow a certain scope (e.g., the Offline Access scope) but that scope is enabled in the authenticator in Curity, a server error will result. For this reason, it is important to align these two configurations or not to define any when configuring the plug-in in Curity.

Creating a Windows Live Authenticator in Curity

The easiest way to configure a new Windows Live authenticator is using the Curity admin UI. The configuration for this can be downloaded as XML or CLI commands later, so only the steps to do this in the GUI will be described.

  1. Go to the Authenticators page of the authentication profile wherein the authenticator instance should be created.

  2. Click the New Authenticator button.

  3. Enter a name (e.g., windowsLive1). This name needs to match the URI component in the callback URI set in the Windows Live app.

  4. For the type, pick the Windows Live option:

  5. On the next page, you can define all of the standard authenticator configuration options like any previous authenticator that should run, the resulting ACR, transformers that should executed, etc. At the bottom of the configuration page, the Windows Live-specific options can be found.


    The Windows Live-specific configuration is generated dynamically based on the configuration model defined in the Java interface.

  6. Certain required and optional configuration settings may be provided. One of these is the HTTP Client setting. This is the HTTP client that will be used to communicate with the Windows Live OAuth server's token and user info endpoints. To define this, do the following:

    1. click the Facilities button at the top-right of the screen.

    2. Next to HTTP, click New.

    3. Enter some name (e.g., windowsliveClient).

  7. Back in the Windows Live authenticator instance that you started to define, select the new HTTP client from the dropdown.

  8. In the Client ID textfield, enter the Application ID from the Windows Live app.

  9. In the Secret Key textfield, enter the Generated Password from the Windows Live app.

  10. If you wish to limit the scopes that Curity will request of Windows Live, toggle on the desired scopes (e.g., Offline Access or Contacts Birthday).

Once all of these changes are made, they will be staged, but not committed (i.e., not running). To make them active, click the Commit menu option in the Changes menu. Optionally enter a comment in the Deploy Changes dialogue and click OK.

Once the configuration is committed and running, the authenticator can be used like any other.


This plugin and its associated documentation is listed under the Apache 2 license.

More Information

Please visit for more information about the Curity Identity Server.

Copyright (C) 2017 Curity AB.