Send Docs Feedback

Registering client apps

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. Log in to your Apigee Edge account.
  2. From the main menu, select Publish > Developer apps
  3. Click + Developer App
  4. Fill out the form:
    1. Enter a name.
    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 she completes 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 a product. You can select one of the default products (or any product you wish). Or create your own
    5. Ignore custom attributes for now.
    6. Click Save
  5. Find your new app in the list of developer apps and select it.
  6. Now, you can 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 products, see What is an API product?.

 

Help or comments?