Skip to main content

Getting a client ID and configuring your app

Before your app can begin to call the Live Connect APIs, you must configure your app with a unique identifier, which we call a client ID. For some app types, you must also configure your app with an associated password, which we call a client secret, and a redirect domain, which is a domain that the APIs use to exchange tokens, data, and messages with your app.

To get a client ID—and to get a client secret and specify a redirect domain, if needed for your app type—here are your options.

  • Metro style app: You only need a client ID.
  • Windows Phone app, and a client-side website or script that uses JavaScript: You need a client ID, and you need to specify a redirect domain.
  • All other app types: You need a client ID and a client secret, and you need to specify a redirect domain.
Anzeige


You get a client ID and a client secret, and you can specify a redirect domain if needed, at the Live Connect app management site (or the Live Connect app management site for Metro style apps).

After you get a client ID, you may want to do one or more of these.

  • All app types: Specify settings for the consent page, which is a UI component that a user must use to okay your app to work with the user's info.
  • All other app types: Change a client secret.

Follow these instructions to do these tasks.

Get a client ID (Metro style apps only)

Go to the Live Connect app management site for Metro style apps (https://manage.dev.live.com/build), and follow the on-screen directions.

Note Do not go to the Live Connect app management site at https://manage.dev.live.com. That site is not designed to create client IDs for Metro style apps.

Top

Get a client ID (all app types except for Metro style apps)

Caution If your app is a Metro style 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.

Top

Specify a redirect domain

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the target client ID.
  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

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the target client ID.
  4. Click Edit settings.
  5. On the app 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, your organization may require you to change your client secret key periodically for security reasons.

  1. Go to the Live Connect app management site.
  2. If prompted, sign in with your Microsoft account credentials.
  3. Click the target client ID.
  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. In the Settings area, click API Settings.
  6. Click Activate.
  7. Click OK.

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.

Top

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, you specify these settings for your app in the Live Connect app management site.

Consent pageLive Connect app management site setting
1. Your app's logoBasic Information page, Application logo image
2. Your app's domain name, which appears in several places in the consent pageAPI Settings page, Redirect Domain box
3. Your app's name, which appears in several places in the consent pageBasic Information page, Application name box
4. Your app's terms hyperlinkBasic Information page, Terms of service URL box
5. Your app's privacy statement hyperlinkBasic 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.)

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

Top

Anzeige