Registering client apps

This page applies to Apigee and Apigee hybrid.

View Apigee Edge documentation.

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

What is registration?

Registration allows Apigee (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

To register a new app, from the Apps page:

Apigee Cloud console

  1. In the Google Cloud console, go to the Distribution > Apps page.

    Go to Apps

  2. Click Create.
  3. Specify the App Details, as described in the following table:
    Field Description Required?
    App Name Name of the app. You can't change the name once the app is created. This name is used in Apigee API calls. Required
    Display Name Display name for the app that appears in the Apigee UI and the developer portal. Optional
    Developer

    Select a developer name from the drop-down.

    Note: For performance reasons, not all developers are displayed in the drop-down. Start typing the developer name or email in the search box, and the drop-down values are automatically refined to match the text you are typing. See also Register app developers.

    		 Required
    Callback URL Typically specifies the URL of an app that is designated to receive an authorization code on behalf of the client app. This value is not required for all API products. Optional
    Notes Descriptive notes for the app. Optional
  4. Specify the Credentials, including the API key expiration, status, and the associated API products. In the Credentials section, click Add credential and enter the following information:
    Field Description
    Expiry Select an expiration duration or date, or set the API key to never expire.
    Products Associate one or more API products with the API key:
    1. Click Add products.
    2. Select one or more API products from list.
    3. Click OK.
    4. Click Add.
  5. Set the Status to Approved or Revoked for each API product. If you added an API product to the credential that requires manual approval, it will show Pending approval status. Otherwise, it will show Approved. In this step, you can change the approval status.
    1. From the list of Products in the Credentials section, select one or more products from the list.
    2. Click Approve or Revoke.
  6. Click Create.
  7. Find your new app in the list of developer apps and select it.
  8. Click to see the Key (client ID) and Secret (client secret) values.

Classic UI

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

    To access the Developer Apps page:

    1. Open the Apigee UI.
    2. Select Publish > Apps in the left navigation bar.
    3. Click + App
    4. 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 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 Create.
    5. Find your new app in the list of developer apps and select it.
    6. Click Show to see the Consumer ID (client ID) and Consumer Secret (client secret) values.

More information

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?.