Registering client apps

You're viewing Apigee Edge documentation.
Go to the Apigee X documentation. info

To participate in OAuth 2.0 flows on Apigee Edge, client apps must be registered.

What is registration?

Registration allows Apigee Edge (the authorization server) to uniquely identify your app. When you register your app, you receive back two keys: a client ID and client secret. The app needs these keys when negotiating for access tokens with the authorization server.

Quick steps

For development and testing, you can use one of the pre-registered developer apps to obtain keys. See Obtaining client credentials for details.

If you want to register a new app:

  1. Access the Developer Apps page, as described below.

    Edge

    To access the Developer Apps page using the Edge UI:

    1. Sign in to apigee.com/edge.
    2. Select Publish > Apps in the left navigation bar.
    3. Click + App

    Classic Edge (Private Cloud)

    To access the Developer Apps page using the Classic Edge UI:

    1. Sign in to http://ms-ip:9000, where ms-ip is the IP address or DNS name of the Management Server node.
    2. Select Publish > Developer Apps in the top navigation bar.
  2. Click + App.
  3. Fill out the form:
    1. Enter a name and display name for the app.
    2. Select a developer (you can choose one of the default developers or create your own).
    3. (Optional) Enter a callback URL. This is used for "three-legged" OAuth grant type flows. This is where Apigee Edge redirects the user after they complete authentication (login) with the resource server. It has to be a complete URL, so you might enter something like https://www.example.com. For more about three-legged OAuth, see Implementing the authorization code grant type.
    4. Add an API product. You can select an existing product or create your own.
    5. Skip the custom attributes section for now.
    6. Click Save.
  4. Find your new app in the list of developer apps and select it.
  5. Click Show to see the Consumer ID (client ID) and Consumer Secret (client secret) values.

Deeper dive

For a more detailed discussion of app registration, see Register apps and manage API keys. If you'd like to know more about the role of API products, see What is an API product?.