Configuring your app

301 out of 385 rated this helpful - Rate this topic

Before your app can call the Live Connect APIs, you must register it and configure its settings. The settings your app needs depends on its type.

How you register and manage your app's Live Connect configuration depends on the app's type.

After you configure your app and get the necessary settings, you might also want to specify settings for the consent page or change a client secret.

Get a package identity (Windows Store apps only)

  1. Go to your Windows Store Dashboard.

    Note  Do not go to the Live Connect app management site. That site is not designed to get package identities for Windows Store apps.

  2. If prompted, sign in with your Microsoft account credentials.
  3. Locate the app in your dashboard.

    • If you haven't entered this app in your Windows Store Dashboard, click Submit an app. Click App name and follow the on-screen directions to name your app. Save the changes to return to the app summary page.
    • If the app is already in your dashboard, find its tile in your dashboard and click Edit.
  4. Click Advanced features.
  5. Click Push Notifications and Live Connect services info.
  6. Follow the on-screen directions below the heading If your app uses Live Connect services, review.
  7. Click Save.

Get a client ID (all app types except for Windows Store apps)

Caution  If your app is a Windows Store app, don't follow these instructions, or else your client ID won't work. You must follow the instructions in the previous section instead.

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. If you are not immediately prompted to provide the app's display name and primary language, click Create application.
  4. Type the app's display name and select the app's primary language.
  5. Read the Live Connect Terms of Use and the privacy statement, and then click I accept. Live Connect creates, and then displays the client ID. It should look something like this: 00000000603E0BFE.

    Note  If your app is a Windows Phone app, an iOS app, or an Android app, you must specify that your app is a mobile client app. (Live Connect uses a different OAuth 2.0 authentication flow for mobile client apps.) To do this, click Application Settings Page, click API Settings, click Yes next to Mobile client app, and then click Save.

Top

Specify a redirect domain

If your app is a Windows Store app, and the app has a companion website, do this:

  1. Go to your Windows Store Dashboard.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Next to the name of your existing app, click Edit.
  4. Click Advanced features.
  5. Click Push Notifications and Live Connect services info.
  6. Click Representing your app to Live Connect users.
  7. In the Redirect Uri box, type the redirect domain.
  8. Click Save.

If your app is not a Windows Store app, do this:

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the client ID of the app you want.
  4. Click Edit settings.
  5. In the Settings area, click API Settings.
  6. In the Redirect Domain box, type the domain that the Live Connect APIs will use to exchange tokens, data, and messages with your app (for example, http://www.contoso.com).
  7. Click Save.

Top

Get a client secret

If your app is a Windows Store app, do this:

  1. Go to your Windows Store Dashboard.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Next to the name of your existing app, click Edit.
  4. Click Advanced features.
  5. Click Push Notifications and Live Connect services info.
  6. Click Authenticating your service.
  7. The client secret is displayed. It should look something like this: qXipuPomaauItsIsmwtKZ2YacGZtCyXD.

If your app is not a Windows Store app, do this:

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the client ID of the app that you want.
  4. Click Edit settings.
  5. On the application summary page, the client secret is displayed. It should look something like this: qXipuPomaauItsIsmwtKZ2YacGZtCyXD.

Top

Change a client secret

You can swap your current client secret for a new client secret if you think your current client secret is compromised or if your organization requires you to change your client secret key periodically for security reasons.

If your app is a Windows Store app, do this:

  1. Go to your Windows Store Dashboard.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Next to the name of your existing app, click Edit.
  4. Click Advanced features.
  5. Click Push Notifications and Live Connect services info.
  6. Click Authenticating your service.
  7. Click Create a new client secret > OK.
  8. After waiting at least 24 hours, return to this page and click Activate > OK.

    Caution  After you click OK, the old client secret won't work anymore. This means that all copies of your app that rely on the old client secret won't work anymore, either.

If your app is not a Windows Store app, do this:

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the client ID of the app that you want.
  4. Click Edit settings.
  5. In the Settings area, click API Settings.
  6. Click Create a new client secret.
  7. Click OK. A new client secret is created and displayed.

Note  Both the old and new client secrets will continue to work until you follow the next set of steps.

When you're ready to stop using the old client secret, do this:

  1. Make sure that all copies of your app are using the new client secret.
  2. Go to the Live Connect app management site.
  3. If prompted, sign in with your Microsoft account credentials.
  4. Click the target client ID.
  5. Click Edit settings.
  6. In the Settings area, click API Settings.
  7. Click Create a new client secret.
  8. After waiting at least 24 hours, return to this page and click Activate.

    Caution  After you click Activate, the old client secret won't work anymore. This means that all copies of your app that rely on the old client secret won't work anymore, either.

  9. Click OK.

Top

Specify consent page settings

After users sign in from your app to a service that is compatible with Live Connect, Live Connect displays the Allow access page (also called the consent page), which explains to the user the types of info that your app wants to access. (For more info about the consent page, see Obtaining user consent.) To customize the items in the consent page, if your app is a Windows Store app, do this:

  1. Go to your Windows Store Dashboard.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Next to the name of your existing app, click Edit.
  4. Click Advanced features.
  5. Click Push Notifications and Live Connect services info.
  6. Click Representing your app to Live Connect users.
  7. Click the Website tab.
  8. Follow the on-screen directions, and then click Save.

If your app is not a Windows Store app, you specify these settings for your app in the Live Connect app management site. Here are the settings you can specify for the consent page.

Note  The following table and screen shots show an English example of the UI. The actual UI that you see may differ depending on your locale.

Consent pageLive Connect app management site setting

1. Your app's logo

Basic Information page, Application logo image

2. Your app's domain name, which appears in several places in the consent page

API Settings page, Redirect Domain box

3. Your app's name, which appears in several places in the consent page

Basic Information page, Application name box

4. Your app's terms hyperlink

Basic Information page, Terms of service URL box

5. Your app's privacy statement hyperlink

Basic Information page, Privacy URL box

 

Note  If the Terms of service URL and Privacy URL settings are not specified, the text | APPLICATION_NAME terms and privacy statement does not appear in the consent page.

The numbered items in the preceding table correspond to the items in the consent page, as shown here. (This page may look a bit different depending on your app type.)

Consent page with callouts

The numbered items also correspond to the items in the Live Connect app management site as shown here.

Note  Again, the following screen shot shows an English example of the UI. The actual UI that you see may differ depending on your locale.

App management site pages with callouts

Top

Live Connect terms

client ID

A unique identifier that is assigned when you register your app with Live Connect.

client secret

A unique password that is created when you register your app with Live Connect.

consent page

A UI component that is displayed to users so they can give your app permission to access their info.

package identity

The combination of a unique package name and publisher.

redirect domain

A domain that you assign for your app and that the Live Connect APIs use to exchange tokens, data, and messages directly with your app or with your app's companion website.

Top

 

 

Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2014 Microsoft. All rights reserved.